-
Notifications
You must be signed in to change notification settings - Fork 66
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Starting my CLI doc draft with this first commit
- Loading branch information
1 parent
86244c8
commit 7ef4dbb
Showing
1 changed file
with
34 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,35 @@ | ||
= Getting started with the CLI | ||
|
||
|
||
|
||
== What PEs need to do | ||
|
||
== What developers need to do | ||
|
||
.Prerequisites | ||
|
||
* Install link:https://kubernetes.io/docs/tasks/tools/[`kubectl`] | ||
* Install link:https://github.com/int128/kubelogin[`kubelogin`] | ||
|
||
.Procedure | ||
|
||
. Get the template `kubeconfig` file for your organization's instance of Konfluence. A PE should be able to provide you with this. | ||
. Using your preferred text editor, in your copy of the template `kubeconfig`, replace <username> with your Konflux username. | ||
. Use one of these two methods for making your `kubeconfig` file accessible to the `kubectl` CLI tool: | ||
.. In your CLI, run the following command: | ||
+ | ||
[source] | ||
-- | ||
export $KUBECONFIG=<path to your kubeconfig file> | ||
-- | ||
+ | ||
.. Or, overwrite the file located at `${HOME}/.kube/config` with your `kubeconfig` file. | ||
. Verify your available contexts by running the following command in your CLI. You should see the `konflux` context. | ||
+ | ||
`kubectl config get-contexts` | ||
. Still in your CLI, set Konflux as the default context: | ||
+ | ||
`kubectl config set-context konflux` | ||
. Trigger a round trip from your machine to the cluster and back, to verify the connection: | ||
+ | ||
`kubectl get cm` |