Skip to content

Commit 1a823ad

Browse files
committed
release(0.1.5): minor tweaking
1 parent f8b18a4 commit 1a823ad

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,17 @@
1717
</p>
1818

1919
If you are using [vcluster](https://www.vcluster.com/) and [ArgoCD](https://argoproj.github.io/argo-cd/), stop reading and jump to [installing](#installing)!
20-
Why? You have probably noticed that ArgoCD does not detect vcluster-spawned clusters out-of-the-box requiring painful manual/automated ad-hoc registration.
21-
I have got you covered. This exporter bridges this gap and allows vCluster clusters to be automatically registered in ArgoCD!
20+
Why? You have probably noticed that ArgoCD does not detect vcluster-spawned clusters out-of-the-box requiring somewhat painful manual/automated ad-hoc registration.
21+
I have got you covered. This exporter bridges the gap and allows vCluster clusters to be automatically registered in ArgoCD!
2222

2323
---
2424

2525
## Installing
2626

2727
### Helm `dependency`
2828
> [!TIP]
29-
> This is particularly useful when you are installing `vcluster` through Helm as well as you can chain the dependencies.
30-
> Don't forget to add the ArgoCD specific `PostSync` hook annotation to ensure that the exporter runs **after** the `vcluster` is installed.
29+
> This is particularly useful when you are already installing `vcluster` through Helm as you can correctly sequence the installation of the exporter.
30+
> Add the ArgoCD specific `PostSync` hook annotation to ensure that the exporter runs **after** the `vcluster` is installed.
3131
> e.g. `values.yaml`
3232
> ```yaml
3333
> vcluster-argocd-exporter:
@@ -53,7 +53,6 @@ helm upgrade <release_name> --install ghcr.io/pcanilho/charts/vcluster-argocd-ex
5353
## Configuring
5454
5555
### Values
56-
Set the `clusters` list to the names of the vClusters you want to export to ArgoCD.
5756
5857
```yaml
5958
# This is a list of names of vClusters to export (vcluster list)
@@ -65,5 +64,6 @@ autoDiscovery: false
6564
# The namespace where ArgoCD has been installed
6665
targetNamespace: argocd
6766
```
68-
The exporter will then create a ArgoCD-ready `v1/Secret` for each vCluster in the list.
69-
All exported clusters will be automatically detected by ArgoCD and added to the list of available clusters.
67+
68+
The exporter will create an ArgoCD-ready `v1/Secret` k8s resource for each vCluster found in the provided list or all
69+
vClusters if the `autoDiscovery` field is used. ArgoCD will automatically detect these secrets and register the clusters.

internal/vcluster/wrapper.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ func ExposeVirtualKubeconfigAsSecret(namespace string, clusters map[string]strin
3131
Namespace: namespace,
3232
Labels: map[string]string{
3333
"argocd.argoproj.io/secret-type": "cluster",
34+
"managed-by": "vcluster-argocd-exporter",
3435
},
3536
},
3637
Type: "opaque",

0 commit comments

Comments
 (0)