From ee8f568a20337ef53c03252c137c1c7262de4c0d Mon Sep 17 00:00:00 2001 From: Ana C Date: Tue, 15 Aug 2023 15:44:45 -0400 Subject: [PATCH] feat: instructions to connect k8s cluster to local machine (#70) * feat: instructions to connect k8s cluster to local machine * feat: updated for consistency * feat: updated for consistency --- docs/launchpad/quick-start.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/launchpad/quick-start.md b/docs/launchpad/quick-start.md index ce90ba01..5e10ad5a 100644 --- a/docs/launchpad/quick-start.md +++ b/docs/launchpad/quick-start.md @@ -48,6 +48,30 @@ task launchpad:setup # For now, this will just run launchpad:deps, which will install all the local tooling dependencies ``` +### Connect your Local environment to your Kubernetes cluster + +To connect your local machine to a Kubernetes cluster, you can follow these general steps: + +**Get Cluster Configuration:** Make sure your [`kubeconfig`](https://devopscube.com/kubernetes-kubeconfig-file/) has been added to `~/.kube/config` file. If you don't have this file, you may need to ask the administrator that created the cluster for the configuration. + +**Verify Configuration:** Open the `config` file in a text editor to verify that it contains the correct cluster details, including server URL, certificates, and context information. + +**Switch Context if working with multiple Kubernetes clusters:** A context in Kubernetes is a combination of a cluster, a user, and a namespace. Use the `kubectl config use-context` command to set your desired context. For example: + + ```sh + kubectl config use-context + ``` + +**Test Connection:** Run a simple `kubectl` command to test if your local machine can connect to the cluster: + + ```sh + kubectl get pods + ``` + + This command should list the pods in the default namespace of your cluster. + +Remember that each cluster might have specific setup steps or requirements, especially if it's managed by a cloud provider. Always refer to the documentation provided by the cluster administrator or the cloud provider for detailed instructions on connecting your local machine to the cluster. + ### 🎉 Milestone: Local environment configured! - [x] We now have our own private git repo containing the declarative configuration for our cluster deployments