You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _docs/installation/gitops/managed-cluster.md
+57-48Lines changed: 57 additions & 48 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,10 +6,7 @@ sub_group: gitops
6
6
toc:true
7
7
---
8
8
9
-
Once you have an Argo CD installation as part of a[hybrid]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops/) or[hosted runtime]({{site.baseurl}}/docs/installation/gitops/hosted-runtime/) you
10
-
can add external deployment clusters to them.
11
-
12
-
Once you add an external cluster, you can deploy applications to that cluster without having to install Argo CD on the clusters in order to do so.
9
+
Once you have an Argo CD installation as part of a[Hybrid]({{site.baseurl}}/docs/installation/gitops/hybrid-gitops/) or[Hosted]({{site.baseurl}}/docs/installation/gitops/hosted-runtime/) GitOps Runtime, you can add external clusters to them. You can then deploy applications to those clusters without having to install Argo CD on the clusters in order to do so.
13
10
14
11
When you add an external cluster to a provisioned GitOps Runtime, the cluster is registered as a managed cluster. A managed cluster is treated as any other managed K8s resource, meaning that you can monitor its health and sync status, deploy applications to it, view information in the Applications dashboard, and remove the cluster from the Runtime's managed list.
15
12
@@ -21,13 +18,20 @@ Adding a managed cluster via Codefresh ensures that Codefresh applies the requir
21
18
##Prerequisites
22
19
23
20
* For_Hosted GitOps_ Runtimes:[Configure access to these IP addresses]({{site.baseurl}}/docs/administration/platform-ip-addresses/)
24
-
* Your Git personal access token is valid and has the[required scopes]({{site.baseurl}}/docs/reference/git-tokens)
25
-
* You have the[latest version of the Codefresh CLI]({{site.baseurl}}/docs/installation/gitops/upgrade-gitops-cli/)
26
-
* You have created a Codefresh token in user settings
27
-
* You know the ingress host of your runtime using`cf runtime list`
28
-
29
-
###Add a managed cluster with GitOps CLI
30
-
Add an external cluster to a provisioned GitOps Runtime through the GitOps CLI. When adding the cluster, you can also add labels and annotations to the cluster, which are added to the cluster secret created by Argo CD.
21
+
* Valid Git personal access token with the[required scopes]({{site.baseurl}}/docs/reference/git-tokens)
22
+
*[Latest version of the Codefresh CLI]({{site.baseurl}}/docs/installation/gitops/upgrade-gitops-cli/)
23
+
* Codefresh token in user settings
24
+
* For ingress-based GitOps Runtimes, the ingress host of the Runtime (use`cf runtime list` to get this)
25
+
26
+
##Adding managed clusters
27
+
Add a managed cluster in any of the following ways:
Add an external cluster to a provisioned GitOps Runtime in the Codefresh UI. When adding the cluster, you can also add labels and annotations to the cluster, which are added to the cluster secret created by Argo CD.
31
35
Optionally, to first generate the YAML manifests, and then manually apply them, use the`dry-run` flag in the CLI.
32
36
33
37
**How to**
@@ -37,7 +41,8 @@ Optionally, to first generate the YAML manifests, and then manually apply them,
37
41
1. From either the**Topology** or**List** views, select the Runtime to which to add the cluster.
*`runtime-name` is the name of the Runtime to which to add the cluster.
@@ -56,7 +61,7 @@ Optionally, to first generate the YAML manifests, and then manually apply them,
56
61
max-width="40%"
57
62
%}
58
63
59
-
{:start="5"}
64
+
{:start="7"}
60
65
1. If you used`dry-run`, apply the generated manifests to the same target cluster on which you ran the command.
61
66
Here is an example of the YAML manifest generated with the`--dry-run` flag. Note that the example has placeholders, which are replaced with the actual values during the`--dry-run`.
62
67
@@ -65,35 +70,34 @@ The new cluster is registered to the GitOps Runtime as a managed cluster.
1. Update`configmap.yml` and`secret.yml` with therequires values.
75
+
1. Run`kustomize build` or`kubectl -k` to apply the final result to the cluster.
71
76
72
-
You can get the`ingressUrl` value of your runtime by running`cf runtime list` in your terminal
73
-
after authenticating to the[Codefresh GitOps CLI]({{site.baseurl}}/docs/installation/cli/).
77
+
>For ingress-based GitOps Runtimes, to get the`ingressUrl` for your, first authenticate to the[Codefresh GitOps CLI]({{site.baseurl}}/docs/installation/cli/), and then run`cf runtime list` in your terminal.
74
78
75
-
###Add a managed cluster with Helm
76
79
77
-
A Helm chart is published athttps://chartmuseum.codefresh.io/csdp-add-cluster. You can see the source templates at[https://github.com/codefresh-io/csdp-official/tree/main/add-cluster/helm](https://github.com/codefresh-io/csdp-official/tree/main/add-cluster/helm).
78
-
79
-
To deploy the chart copy locally[https://github.com/codefresh-io/csdp-official/blob/main/add-cluster/helm/values.yaml](https://github.com/codefresh-io/csdp-official/blob/main/add-cluster/helm/values.yaml) and fill in the required values.
80
+
###Add a managed cluster with Helm
80
81
81
-
Then run
82
+
The Helm chart is published athttps://chartmuseum.codefresh.io/csdp-add-cluster. You can see the source templates at[https://github.com/codefresh-io/csdp-official/tree/main/add-cluster/helm](https://github.com/codefresh-io/csdp-official/tree/main/add-cluster/helm){:target="\_blank"}.
>For ingress-based GitOps Runtimes, to get the`ingressUrl` for your, first authenticate to the[Codefresh GitOps CLI]({{site.baseurl}}/docs/installation/cli/), and then run`cf runtime list` in your terminal.
96
+
90
97
91
-
You can get the`ingressUrl` value of your runtime by running`cf runtime list` in your terminal
92
-
after authenticating to the[Codefresh GitOps CLI]({{site.baseurl}}/docs/installation/cli/).
93
-
94
-
###Add a manage cluster with Terraform
98
+
###Add a managed cluster with Terraform
95
99
96
-
Use the[Helm provider](https://registry.terraform.io/providers/hashicorp/helm/latest/docs) as any other Helm chart.
100
+
*Use the[Helm provider](https://registry.terraform.io/providers/hashicorp/helm/latest/docs) as any other Helm chart.
* Apply the file using Terraform or your favorite workflow tool.
109
115
110
-
And then apply the file using Terraform or your favorite workflow tool.
111
-
112
-
##Work with managed clusters
113
-
Work with managed clusters in either the Topology or List Runtime views. For information on Runtime views, see[Runtime views]({{site.baseurl}}/docs/installation/gitops/monitor-manage-runtimes/#gitops-runtime-views).
116
+
##View managed clusters
117
+
View managed clusters in either the Topology or List Runtime views. For information on Runtime views, see[Runtime views]({{site.baseurl}}/docs/installation/gitops/monitor-manage-runtimes/#gitops-runtime-views).
114
118
As the cluster is managed through the Runtime, updates to the Runtime automatically updates the components on all the managed clusters that include it.
115
119
116
120
View connection status for the managed cluster, and health and sync errors. Health and sync errors are flagged by the error notification in the toolbar, and visually flagged in the List and Topology views.
117
121
118
-
###Install Argo Rollouts
122
+
##Install Argo Rollouts
119
123
Applications with`rollout` resources need Argo Rollouts on the target cluster, both to visualize rollouts in the Applications dashboard and control rollout steps with the Rollout Player.
120
-
If Argo Rollouts has not been installed on the target cluster,it displays**Install Argo Rollouts** button.
124
+
If Argo Rollouts has not been installed on the target cluster,the**Install Argo Rollouts** button displayed.
121
125
122
126
Install Argo Rollouts with a single click to execute rollout instructions, deploy the application, and visualize rollout progress in the[Applications dashboard]({{site.baseurl}}/docs/deployments/gitops/applications-dashboard/).
123
127
124
128
125
-
1. In the Codefresh UI, on the toolbar, click the**Settings** icon,expandRuntimes in the sidebar, and select[**GitOps Runtimes**](https://g.codefresh.io/2.0/account-settings/runtimes){:target="\_blank"}.
129
+
1. In the Codefresh UI, on the toolbar, click the**Settings** icon,and fromRuntimes in the sidebar, select[**GitOps Runtimes**](https://g.codefresh.io/2.0/account-settings/runtimes){:target="\_blank"}.
126
130
1. Select**Topology View**.
127
131
1. Select the target cluster, and then select**+ Install Argo Rollouts**.
128
132
@@ -136,15 +140,22 @@ Install Argo Rollouts with a single click to execute rollout instructions, deplo
136
140
max-width="40%"
137
141
%}
138
142
139
-
##Remove a managed cluster
143
+
##Removing managed clusters
144
+
145
+
Removing a cluster as a deployment target means removing it from the GitOps Runtime that manages it.
140
146
141
-
When you want to remove a cluster as a deployment target you can unlink it fromtheruntime that manages it.
147
+
>This action only removes the management link between your GitOps Runtime and your cluster. Applications that are already running onthecluster are not affected.
142
148
143
-
Note that this only removes the management link between your runtime and your cluster. It doesn't do anything with the applications that are already running on the cluster.
149
+
Remove a managed cluster in any of the following ways: