Skip to content

Commit 84e2213

Browse files
committed
added release docs and updated the README
1 parent 2035ec9 commit 84e2213

File tree

2 files changed

+31
-0
lines changed

2 files changed

+31
-0
lines changed

README.md

+28
Original file line numberDiff line numberDiff line change
@@ -269,6 +269,34 @@ For example, consider the GitHub example. Flux's `install.yaml` contains all the
269269
and Service objects too. Bootstrap doesn't care. It only installs the CRDs from that by using server-side-apply.
270270

271271
The status of the Bootstrap object will keep track of what CRDs it installed.
272+
273+
## Remote Cluster
274+
275+
It's possible to define a target cluster to apply CRDs into. This is done using a KubeConfig secret and then
276+
referencing that secret via `KubeConfig.SecretRef` like this:
277+
278+
```yaml
279+
apiVersion: delivery.crd-bootstrap/v1alpha1
280+
kind: Bootstrap
281+
metadata:
282+
name: bootstrap-sample
283+
spec:
284+
interval: 10s
285+
source:
286+
url:
287+
url: https://raw.githubusercontent.com/krok-o/operator/main/config/crd/bases/delivery.krok.app_krokevents.yaml
288+
kubeConfig: # define a secret which contains the KubeConfig to access the target cluster.
289+
secretRef:
290+
secretRef:
291+
name: kubeconfig
292+
key: kubeconfig
293+
```
294+
295+
There is also an option to define a ServiceAccount for impersonating in the target cluster using `KubeConfig.ServiceAccount`.
296+
297+
Once the secret is defined and used the CRD should be applied in the target cluster. All further operations should
298+
function as is.
299+
272300
## Contributing
273301

274302
Contributions are always welcomed.

docs/release_notes/v0.9.0.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Release v0.9.0
2+
3+
Added ability to apply CRDs into a target cluster using a KubeConfig.

0 commit comments

Comments
 (0)