diff --git a/cli_reference/openshift_cli/configuring-cli.adoc b/cli_reference/openshift_cli/configuring-cli.adoc index 7b91e26c250f..d0f915c3e167 100644 --- a/cli_reference/openshift_cli/configuring-cli.adoc +++ b/cli_reference/openshift_cli/configuring-cli.adoc @@ -16,3 +16,10 @@ include::modules/cli-configuring-completion.adoc[leveloffset=+2] // Enabling tab completion for Zsh include::modules/cli-configuring-completion-zsh.adoc[leveloffset=+2] + +[id="cli-configuring-kubeconfig_{context}"] +== Configuring a kubeconfig file by using the oc CLI + +You can use the `oc` Command-Line Interface (CLI) to log in to your OpenShift cluster and retrieve the `kubeconfig` file. The `kubeconfig` file contains the configuration information required to interact with the cluster using CLI tools such as `kubectl` or `oc`. + +include::modules/cli-configuring-kubeconfig-using-cli.adoc[leveloffset=+2] \ No newline at end of file diff --git a/modules/cli-configuring-kubeconfig-using-cli.adoc b/modules/cli-configuring-kubeconfig-using-cli.adoc new file mode 100644 index 000000000000..8469b86297f6 --- /dev/null +++ b/modules/cli-configuring-kubeconfig-using-cli.adoc @@ -0,0 +1,50 @@ +// Module included in the following assemblies: +// +// * cli_reference/openshift_cli/configuring-cli.adoc + +:_mod-docs-content-type: PROCEDURE +[id="cli-accessing-kubeconfig-using-cli_{context}"] += Accessing `kubeconfig` using the `oc` CLI + +You can use the `oc` CLI to log in to your OpenShift cluster and retrieve a kubeconfig file for accessing the cluster from the command line. + +.Prerequisites + +* You have access to the {product-title} web console or API server endpoint. + +.Procedure + +. Log in to your OpenShift cluster by running the following command: ++ +[source,terminal] +---- +$ oc login -u -p <1> +---- ++ +<1> Replace `` with the full API server URL, such as `https://api.my-cluster.example.com:6443`. + +. Save the cluster configuration to a local file by running the following command: ++ +[source,terminal] +---- +$ oc config view --raw > kubeconfig +---- + +. Set the `KUBECONFIG` environment variable to point to the exported file by running the following command: ++ +[source,terminal] +---- +$ export KUBECONFIG=./kubeconfig +---- + +. You can now use `kubectl` to interact with your OpenShift cluster by running the following command: ++ +[source,terminal] +---- +$ kubectl get nodes +---- + +[NOTE] +==== +If you plan to reuse the exported `kubeconfig` file across sessions or machines, store it securely and avoid committing it to source control. +==== \ No newline at end of file