forked from argoproj/argo-cd
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Proposal to add installation steps for local development using …
…Kind (argoproj#20821) * Update getting_started.md Adding some steps for running Argo CD locally using Kind. Signed-off-by: Revital Barletz <[email protected]> * Moved instructions to a different file Signed-off-by: Revital Barletz <[email protected]> * Update getting_started.md Moved the instructions to a different file. Signed-off-by: Revital Barletz <[email protected]> * Update try_argo_cd_locally.md Signed-off-by: Revital Barletz <[email protected]> * Update try_argo_cd_locally.md Signed-off-by: Revital Barletz <[email protected]> * Update docs/try_argo_cd_locally.md Signed-off-by: Dan Garfield <[email protected]> * Update try_argo_cd_locally.md Signed-off-by: Revital Barletz <[email protected]> --------- Signed-off-by: Revital Barletz <[email protected]> Signed-off-by: Dan Garfield <[email protected]> Co-authored-by: Dan Garfield <[email protected]>
- Loading branch information
1 parent
ff08643
commit a849d41
Showing
2 changed files
with
54 additions
and
1 deletion.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# Try Argo CD Locally | ||
|
||
!!! tip | ||
This guide assumes you have a grounding in the tools that Argo CD is based on. Please read [understanding the basics](understand_the_basics.md) to learn about these tools. | ||
|
||
|
||
Follow these steps to install `Kind` for local development and set it up with Argo CD. | ||
|
||
To run an Argo CD development environment [review the developer guide for running locally](../developer-guide/running-locally). | ||
|
||
## Install Kind | ||
|
||
Install Kind Following Instructions [here](https://kind.sigs.k8s.io/docs/user/quick-start#installation). | ||
|
||
## Create a Kind Cluster | ||
Once Kind is installed, create a new Kubernetes cluster with: | ||
```bash | ||
kind create cluster --name argocd-cluster | ||
``` | ||
This will create a local Kubernetes cluster named `argocd-cluster`. | ||
|
||
## Set Up kubectl to Use the Kind Cluster | ||
After creating the cluster, set `kubectl` to use your new `kind` cluster: | ||
```bash | ||
kubectl cluster-info --context kind-argocd-cluster | ||
``` | ||
This command verifies that `kubectl` is pointed to the right cluster. | ||
|
||
## Install ArgoCD on the Cluster | ||
You can now install Argo CD on your `kind` cluster. First, apply the Argo CD manifest to create the necessary resources: | ||
```bash | ||
kubectl create namespace argocd | ||
kubectl apply -n argocd -f https://raw.githubusercontent.com/argoproj/argo-cd/stable/manifests/install.yaml | ||
``` | ||
|
||
## Expose ArgoCD API Server | ||
By default, Argo CD's API server is not exposed outside the cluster. You need to expose it to access the UI locally. For development purposes, you can use Kubectl 'port-forward'. | ||
```bash | ||
kubectl port-forward svc/argocd-server -n argocd 8080:443 | ||
``` | ||
This will forward port 8080 on your local machine to the ArgoCD API server’s port 443 inside the Kubernetes cluster. | ||
|
||
## Access ArgoCD UI | ||
Now, you can open your browser and navigate to http://localhost:8080 to access the ArgoCD UI. | ||
|
||
### Log in to ArgoCD | ||
To log in to the ArgoCD UI, you'll need the default admin password. You can retrieve it from the Kubernetes cluster: | ||
```bash | ||
kubectl -n argocd get secret argocd-initial-admin-secret -o jsonpath='{.data.password}' | base64 -d | ||
``` | ||
Use the admin username and the retrieved password to log in. | ||
|
||
You can now move on to step #2 in the [Getting Started Guide](getting_started.md]. |