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.

Sign up for GitHub

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

Jump to bottom

Update release references to next version #136

Merged
merged 1 commit into from
Sep 1, 2022
Merged

Update release references to next version #136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
35 changes: 10 additions & 25 deletions docs/src/gs/install-cluster-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,14 @@

# Install Cluster API Provider for Oracle Cloud Infrastructure

1. If you are not using [kind][kind] for your management cluster, export the `KUBECONFIG` environment variable to point to the correct Kubeconfig file.
If you are not using [kind][kind] for your management cluster, export the `KUBECONFIG` environment variable to point to the correct Kubeconfig file.

```shell
export KUBECONFIG=/path/to/kubeconfig
```

2. Create a file `clusterctl.yaml` in `$HOME/.cluster-api/`

```shell
touch "$HOME"/.cluster-api/clusterctl.yaml
```

3. Add the Oracle Cloud Infrastructure (OCI) Provider in `clusterctl.yaml`:

```yaml
providers:
- name: oci
url: https://github.com/oracle/cluster-api-provider-oci/releases/v0.4.0/infrastructure-components.yaml
type: InfrastructureProvider
export KUBECONFIG=/path/to/kubeconfig
```

## Configure authentication
Before installing Cluster API Provider for OCI (CAPOCI), you must first set up your preferred
Before installing Cluster API Provider for OCI (CAPOCI), you must first set up your preferred
authentication mechanism using specific environment variables.

### User Principal
Expand All @@ -49,7 +34,7 @@ credentials.

### Instance Principal

If the management cluster is hosted in Oracle Cloud Infrastructure, [Instance principals][instance-principals] authentication
If the management cluster is hosted in Oracle Cloud Infrastructure, [Instance principals][instance-principals] authentication
is recommended. Export the following parameters to use Instance Principals. If Instance Principals are used, the user principal
parameters explained in above section will not be used.

Expand All @@ -70,18 +55,18 @@ allow dynamic-group [your dynamic group name] to manage load-balancers in compar
Initialize management cluster and install CAPOCI

```bash
clusterctl init --infrastructure oci
clusterctl init --infrastructure oci:v0.6.0
shyamradhakrishnan marked this conversation as resolved.
Show resolved Hide resolved
```

## CAPOCI Components

When installing CAPOCI, the following components will be installed in the management cluster:

1. A custom resource definition (`CRD`) for `OCICluster`, which is a Kubernetes custom resource that represents a workload cluster created in OCI by CAPOCI.
2. A custom resource definition (`CRD`) for `OCIMachine`, which is a Kubernetes custom resource that represents one node in the workload cluster created in OCI by CAPOCI.
3. Role-based access control resources for a Kubernetes `Deployment`, `ServiceAccount`, `Role`, `ClusterRole` and `ClusterRoleBinding`
4. A Kubernetes `Secret` which will hold OCI credentials
5. A Kubernetes `Deployment` with the CAPOCI image - ghcr.io/oracle/cluster-api-oci-controller: `<version>`
1. A custom resource definition (`CRD`) for `OCICluster`, which is a Kubernetes custom resource that represents a workload cluster created in OCI by CAPOCI.
2. A custom resource definition (`CRD`) for `OCIMachine`, which is a Kubernetes custom resource that represents one node in the workload cluster created in OCI by CAPOCI.
3. Role-based access control resources for a Kubernetes `Deployment`, `ServiceAccount`, `Role`, `ClusterRole` and `ClusterRoleBinding`
4. A Kubernetes `Secret` which will hold OCI credentials
5. A Kubernetes `Deployment` with the CAPOCI image - ghcr.io/oracle/cluster-api-oci-controller: `<version>`

Please inspect the `infrastructure-components.yaml` present in the release artifacts to know more.

Expand Down
15 changes: 15 additions & 0 deletions metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,21 @@
# update this file only when a new major or minor version is released
apiVersion: clusterctl.cluster.x-k8s.io/v1alpha3
releaseSeries:
- major: 0
minor: 1
contract: v1beta1
- major: 0
minor: 2
contract: v1beta1
- major: 0
minor: 3
contract: v1beta1
- major: 0
minor: 4
contract: v1beta1
- major: 0
minor: 5
contract: v1beta1
- major: 0
minor: 6
contract: v1beta1