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

docs: update outdated installation instructions for civo kubernetes cluster #61

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update outdated installation instructions for civo kubernetes cluster #61

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 20 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,30 @@ This will trigger the creation of another cluster in the destination region you
- [KinD installed](https://kind.sigs.k8s.io/docs/user/quick-start/) (optionally another Kubernetes cluster)
- [Helm installed](https://helm.sh/)

Set-up a Kubernetes cluster with Crossplane installed. The instructions can be found in the official [Crossplane documentation](https://crossplane.io/docs/v1.3/getting-started/install-configure.html#start-with-a-self-hosted-crossplane).
Set-up a Kubernetes cluster with Crossplane installed. The instructions can be found in the official [Crossplane documentation](https://docs.crossplane.io/latest/software/install/).

To add the Civo Provider Configuration Package, run:
Once Crossplane is installed, the provider Configuration Package can be added.

To add the Civo Provider Configuration Package create a new manifest referencing the provider:

`civo-provider.yaml`
```
apiVersion: pkg.crossplane.io/v1
kind: Provider
metadata:
name: provider-civo
namespace: crossplane-system
spec:
package: xpkg.upbound.io/civo/provider-civo:v0.1
```

Apply the resources to the cluster:

```console
kubectl crossplane install provider xpkg.upbound.io/civo/provider-civo:v0.1
```
kubectl apply -f civo-provider.yaml
```

In this case, we are going to follow the resources in the example repostory.
In this case, we are going to follow the resources in the example repository.

Before creating a Provider resource, edit the API key in [provider.yaml](examples/civo/provider/provider.yaml). You can find the API key in your Civo account at [Settings > Profile > Security](https://dashboard.civo.com/security).

Expand All @@ -76,7 +91,6 @@ NAME READY MESSAGE APPLICATIONS
test-crossplane True Cluster is active ["argo-cd","prometheus-operator"]
```


### Connection details

With the use of `kubectl` it is possible to retrieve the `CivoKubernetes` kubeconfig directly.
Expand Down
9 changes: 3 additions & 6 deletions examples/civo/cluster/cluster.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,11 @@ spec:
pools:
- id: "8382e422-dcdd-461f-afb4-2ab67f171c3e"
count: 2
size: g3.k3s.small
size: "g4s.kube.small"
- id: "8482f422-dcdd-461g-afb4-2ab67f171c3e"
count: 1
size: g3.k3s.small
applications:
- "argo-cd"
- "prometheus-operator"
version: "1.22.2-k3s1"
size: "g4s.kube.small"
version: "v1.29.2-k3s1"
connectionDetails:
connectionSecretNamePrefix: "cluster-details"
connectionSecretNamespace: "default"
Expand Down
Loading