Skip to content

Commit eaa9bd0

Browse files
author
Jan Schoone
committed
docs(usage): add publishing to OCI registry
Signed-off-by: Jan Schoone <[email protected]>
1 parent be55eeb commit eaa9bd0

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

docs/how_to_use_csctl.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,3 +77,30 @@ $ csctl create <path-to-cluster-stack-directory> --output <path-to-output-direct
7777
```
7878

7979
You have to be authenticated to your cloud provider and container registry to which you want to upload the node images.
80+
81+
### Publish Cluster Stacks on OCI Registry
82+
83+
`csctl` can create and publish Cluster Stack releases directly to an OCI registry.
84+
85+
To authenticate with an OCI registry the variables `OCI_REGISTRY`,
86+
`OCI_REPOSITORY`, `OCI_USERNAME` and `OCI_PASSWORD` are needed. If a registry
87+
with access token support is used `OCI_ACCESS_TOKEN` can be used alternatively
88+
to username/password.
89+
`OCI_REPOSITORY` needs to include the registry URL.
90+
91+
Example:
92+
93+
```sh
94+
export OCI_REGISTRY=registry.scs.community
95+
export OCI_REPOSITORY=$OCI_REGISTRY/csctl-oci/openstack
96+
export OCI_USERNAME=<myusername>
97+
export OCI_PASSWORD=<mypassword>
98+
```
99+
100+
When set add parameters `--publish` and `--remote oci` to `csctl create command`:
101+
102+
```bash
103+
$ csctl create --publish --remote oci <path-to-cluster-stack-directory> \
104+
--output <path-to-output-directory> \
105+
--mode hash --node-image-registry <url-of-registry>
106+
```

0 commit comments

Comments
 (0)