https://github.com/githubixx/ansible-role-kubectl
Installs kubectl command line utility used to interact with the Kubernetes API Server
https://github.com/githubixx/ansible-role-kubectl
ansible ansible-role kubectl kubernetes
Last synced: 3 months ago
JSON representation
Installs kubectl command line utility used to interact with the Kubernetes API Server
- Host: GitHub
- URL: https://github.com/githubixx/ansible-role-kubectl
- Owner: githubixx
- License: gpl-3.0
- Created: 2017-09-14T18:55:51.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2025-01-21T21:30:09.000Z (5 months ago)
- Last Synced: 2025-03-24T18:11:38.491Z (3 months ago)
- Topics: ansible, ansible-role, kubectl, kubernetes
- Size: 80.1 KB
- Stars: 19
- Watchers: 2
- Forks: 17
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ansible-role-kubectl
Installs `kubectl` command line utility used to interact with the Kubernetes API Server.
## Versions
I tag every release and try to stay with [semantic versioning](http://semver.org). If you want to use the role I recommend to checkout the latest tag. The master branch is basically development while the tags mark stable releases. But in general I try to keep master in good shape too. A tag `23.3.0+1.31.5` means this is release `23.3.0` of this role and `kubectl` client binary version is `1.31.5`. If the role itself changes `X.Y.Z` before `+` will increase. If the Kubernetes version changes `X.Y.Z` after `+` will increase. This allows to tag bugfixes and new major versions of the role while it's still developed for a specific Kubernetes release.
## Changelog
**Change history:**
See full [CHANGELOG](https://github.com/githubixx/ansible-role-kubectl/blob/master/CHANGELOG.md)
**Recent changes:**
## 23.3.0+1.31.5
- update kubectl to `v1.31.5`
## 23.2.0+1.30.5
- update kubectl to `v1.30.5`
- Download URL of `kubectl` archive has changed. `https://storage.googleapis.com` doesn't work anymore. Using `https://dl.k8s.io` instead now (see [Client Binaries](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG/CHANGELOG-1.30.md#client-binaries)).
- update `.yamllint`
- update `meta/main.yml`
- Molecule: update tests
- Molecule: fix various `ansible-lint` issues
## Installation
- Directly download from Github (Change into Ansible roles directory before cloning. You can figure out the role path by using `ansible-config dump | grep DEFAULT_ROLES_PATH` command):
`git clone https://github.com/githubixx/ansible-role-kubectl.git githubixx.kubectl`
- Via `ansible-galaxy` command and download directly from Ansible Galaxy:
`ansible-galaxy install role githubixx.kubectl`
- Create a `requirements.yml` file with the following content (this will download the role from Github) and install with
`ansible-galaxy role install -r requirements.yml` (change `version` if needed):
```yaml
---
roles:
- name: githubixx.kubectl
src: https://github.com/githubixx/ansible-role-kubectl.git
version: 23.3.0+1.31.5
```
## Role Variables
```yaml
# "kubectl" version to install
kubectl_version: "1.31.5"
# The default "binary" will download "kubectl" as a binary file. This is
# about 2.5x bigger then the ".tar.gz" file. The tarball needs to be unarchived
# by the role first after downloading and is smaller.
#
# If you specify "binary" the "kubectl" binary file will be downloaded. In
# contrast to the tarball the binary file is about 2.5x bigger but doesn't
# need to be unarchived by this role.
#
# If download file size is important for you (e.g. slow download or download
# over mobile link) stay with "archive". Otherwise "binary" might be an option.
kubectl_download_filetype: "binary"
#
# SHA512 checksum of the "kubernetes-client-linux-amd64.tar.gz" file
# (see https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG/CHANGELOG-1.31.md#client-binaries)
kubectl_checksum_archive: "sha512:de866a5841bff9b9e6666e0065c2bfd0a8420d8fa2cb3b62ea6191105a2d8661dc44250c0d5e5ad4ed1a34348c75b25e55f25d78dc15cc4d3681946f71d59121"
#
# SHA512 checksum of the binary. There is normally no need to change it.
# Further information:
# - https://kubernetes.io/releases/download/#binaries
# - https://www.downloadkubernetes.com/
kubectl_checksum_binary: "sha512:https://cdn.dl.k8s.io/release/v{{ kubectl_version }}/bin/{{ kubectl_os }}/{{ kubectl_arch }}/kubectl.sha512"
# Where to install "kubectl" binary
kubectl_bin_directory: "/usr/local/bin"
# Directory to store the kubectl archive
kubectl_tmp_directory: "{{ lookup('env', 'TMPDIR') | default('/tmp', true) }}"
# Owner of "kubectl" binary
kubectl_owner: "root"
# Group of "kubectl" binary
kubectl_group: "root"
# Specifies the permissions of the "kubectl" binary
kubectl_binary_mode: "0755"
# Operating system on which "kubectl" should run on
kubectl_os: "linux" # use "darwin" for MacOS X, "windows" for Windows
# Processor architecture "kubectl" should run on
kubectl_arch: "amd64" # other possible values: "386","arm64","arm","ppc64le","s390x"
```
## Testing
This role has a small test setup that is created using [molecule](https://github.com/ansible-community/molecule). To run the tests follow the molecule [install guide](https://molecule.readthedocs.io/en/latest/installation.html). Also ensure that a Docker daemon runs on your machine.
Assuming [Docker](https://www.docker.io) is already installed you need at least two Python packages:
```bash
pip3 install --user molecule
pip3 install --user molecule-docker
```
Afterwards molecule can be executed:
```bash
molecule converge
```
This will setup a few Docker container with Ubuntu 20.04/22.04/24.04 and Debian 11/12 with `kubectl` installed. To verify if everything worked:
```bash
molecule verify
```
To clean up run
```bash
molecule destroy
```
## Example Playbook
```yaml
- hosts: your-host
roles:
- githubixx.kubectl
```
## License
GNU GENERAL PUBLIC LICENSE Version 3
## Author Information
[TauCeti Blog](http://www.tauceti.blog)