Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document IRSA etc #33

Merged
merged 3 commits into from
Nov 27, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,27 @@ Nexus Configuration Controller (NCC) provides synchronization capability for mul
Nexus Configuration Controller installs via helm:
```shell
helm install nexus-configuration-controller oci://ghcr.io/sneaksanddata/helm/nexus-configuration-controller \
--version v0.1.0 \
--namespace nexus
--version v0.1.1 \
--namespace nexus \
--controller.shardsConfigSecretName ncc-shards
```

Controller expects the cluster to provide a secret that contains kubeconfig data for each shard cluster. For each shard, there must be a separate entry named `<cluster_name>.kubeconfig` with relevant kubeconfig data as a value. Example:

```yaml
apiVersion: v1
kind: Secret
metadata:
name: ncc-shards
namespace: nexus
immutable: true
data:
my-k8s-cluster-0.kubeconfig: base64(kubeconfig for my-k8s-cluster-0)
type: Opaque
```

Additionally, if you run on EKS, you need to either set explicit AWS credentials or set up node role or IRSA and map service account role to a respective role in the shard cluster.

## Operation
Once installed, NCC does not require any additional configuration. It will adopt existing resources in the *shard* clusters and synchronize them to the version in the controller cluster, as well as start propagating changes to secrets and configurations.
If you have secrets already present in the *shards* clusters, you must remove them or the sync will fail for the affected resources.
Loading