Skip to content

Commit

Permalink
added release docs and updated the README
Browse files Browse the repository at this point in the history
  • Loading branch information
Skarlso committed Aug 7, 2024
1 parent 2035ec9 commit 84e2213
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -269,6 +269,34 @@ For example, consider the GitHub example. Flux's `install.yaml` contains all the
and Service objects too. Bootstrap doesn't care. It only installs the CRDs from that by using server-side-apply.

The status of the Bootstrap object will keep track of what CRDs it installed.

## Remote Cluster

It's possible to define a target cluster to apply CRDs into. This is done using a KubeConfig secret and then
referencing that secret via `KubeConfig.SecretRef` like this:

```yaml
apiVersion: delivery.crd-bootstrap/v1alpha1
kind: Bootstrap
metadata:
name: bootstrap-sample
spec:
interval: 10s
source:
url:
url: https://raw.githubusercontent.com/krok-o/operator/main/config/crd/bases/delivery.krok.app_krokevents.yaml
kubeConfig: # define a secret which contains the KubeConfig to access the target cluster.
secretRef:
secretRef:
name: kubeconfig
key: kubeconfig
```

There is also an option to define a ServiceAccount for impersonating in the target cluster using `KubeConfig.ServiceAccount`.

Once the secret is defined and used the CRD should be applied in the target cluster. All further operations should
function as is.

## Contributing

Contributions are always welcomed.
Expand Down
3 changes: 3 additions & 0 deletions docs/release_notes/v0.9.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Release v0.9.0

Added ability to apply CRDs into a target cluster using a KubeConfig.

0 comments on commit 84e2213

Please sign in to comment.