Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Standardize format of kubectl. Fix typo with display of k8s-workertoo… #2552

Merged
merged 3 commits into from
Nov 7, 2024
Merged

Standardize format of kubectl. Fix typo with display of k8s-workertoo… #2552

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2faff0e
Standardize format of kubectl. Fix typo with display of k8s-workertoo…
adrianparker Nov 6, 2024
662b480
Merge branch 'main' into kubectl-typo-fix
steve-fenton-octopus Nov 7, 2024
513bfaf
Update modDate
steve-fenton-octopus Nov 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/pages/docs/kubernetes/resources/kubectl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
layout: src/layouts/Default.astro
pubDate: 2023-01-01
modDate: 2024-07-31
modDate: 2024-11-07
title: kubectl
description: The kubectl utility is required by Octopus Deploy Kubernetes integration.
navOrder: 100
---

The [kubectl command-line tool](https://kubernetes.io/docs/reference/kubectl/overview/) is required by Octopus Deploy's Kubernetes features.

kubectl is not bundled with Octopus, and must be pre-installed on the [worker](/docs/infrastructure/workers/) or Octopus Server which will execute steps and health checks against a [Kubernetes target](/docs/kubernetes/targets/kubernetes-api). Alternatively, [execution containers](/docs/projects/steps/execution-containers-for-workers) may be used and we recommend using `[octopuslabs/k8s-workertools](https://hub.docker.com/r/octopuslabs/k8s-workertools)` docker image, we also recommend setting the tag to a version that is compatible with the version of your cluster, [read the official version skew policy](https://kubernetes.io/releases/version-skew-policy/#kubectl) for more information.
`kubectl` is not bundled with Octopus, and must be pre-installed on the [worker](/docs/infrastructure/workers/) or Octopus Server which will execute steps and health checks against a [Kubernetes target](/docs/kubernetes/targets/kubernetes-api). Alternatively, [execution containers](/docs/projects/steps/execution-containers-for-workers) may be used and we recommend using [`octopuslabs/k8s-workertools`](https://hub.docker.com/r/octopuslabs/k8s-workertools) docker image, we also recommend setting the tag to a version that is compatible with the version of your cluster, [read the official version skew policy](https://kubernetes.io/releases/version-skew-policy/#kubectl) for more information.

By default, Octopus assumes `kubectl` is available in the PATH environment variable. A specific location for `kubectl` can be supplied by setting a `Octopus.Action.Kubernetes.CustomKubectlExecutable` variable in the Octopus project (an example value is `c:\tools\kubectl\version\kubectl.exe`).
Loading