-
-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Kubectl command documentation (#154)
* kubectl documentation * update documentation: configure and shell commands * Apply suggestions from code review Co-authored-by: Angelo Fenoglio <angelofenoglio@gmail.com> --------- Co-authored-by: Angelo Fenoglio <angelofenoglio@gmail.com>
- Loading branch information
1 parent
293028a
commit 6cd62c2
Showing
4 changed files
with
55 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
# Command: `kubectl` | ||
|
||
!!! info "Regarding Leverage Toolbox versions" | ||
To have this feature available, Leverage Toolbox versions `1.2.7-0.1.7` and up, or `1.3.5-0.1.7` and up must be used. | ||
|
||
The `kubectl` command is a wrapper for a containerized installation of [kubectl](https://kubernetes.io/docs/reference/kubectl/). It provides the kubectl executable with specific configuration values required by Leverage. | ||
|
||
It transparently handles authentication, whether it is Multi-Factor or via Single Sign-On, on behalf of the user in the commands that require it. SSO Authentication takes precedence over MFA when both are active. | ||
|
||
The sub-commands can only be run at **layer** level and will not run anywhere else in the project. | ||
The sub-command `configure` can only be run at an **EKS cluster layer** level. Usually called `cluster`. | ||
|
||
The command can also be invoked via its shortened version `kc`. | ||
|
||
--- | ||
## `run` | ||
|
||
### Usage | ||
``` bash | ||
leverage kubectl [commands] [arguments] | ||
``` | ||
|
||
Equivalent to `kubectl`. | ||
|
||
All arguments given are passed as received to kubectl. | ||
|
||
**Example:** | ||
|
||
```bash | ||
leverage kubectl get pods --namespace monitoring | ||
``` | ||
|
||
--- | ||
## `shell` | ||
|
||
### Usage | ||
``` bash | ||
leverage kubectl shell | ||
``` | ||
|
||
Open a shell into the Kubectl container in the current directory. | ||
|
||
--- | ||
## `configure` | ||
|
||
### Usage | ||
``` bash | ||
leverage kubectl configure | ||
``` | ||
|
||
Add the cluster from the EKS layer into your kubectl config file. | ||
Equivalent to `aws eks update-kubeconfig ...`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters