diff --git a/README.md b/README.md index 4ae7716..5d72a51 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,146 @@ + # Provider opentelekomcloud -`provider-opentelekomcloud` is a [Crossplane](https://crossplane.io/) provider that -is built using [Upjet](https://github.com/crossplane/upjet) code -generation tools and exposes XRM-conformant managed resources for the -opentelekomcloud API. +`provider-opentelekomcloud` is a [Crossplane](https://crossplane.io/) provider that is built using [Upjet](https://github.com/crossplane/upjet) code generation tools and exposes XRM-conformant managed resources for the opentelekomcloud API. + +## 🚨 **Note: This project is still under development and is not recommended for use in production environments.** 🚨 ## Getting Started -Install the provider by using the following command after changing the image tag -to the [latest release](https://marketplace.upbound.io/providers/opentelekomcloud/provider-opentelekomcloud): +### Install provider-opentelekomcloud + +#### Install Crossplane + +Before you begin, make sure you have the following tools installed: +- [kubectl](https://kubernetes.io/docs/reference/kubectl/kubectl/) +- [helm](https://helm.sh/docs/intro/install/) +- [up](https://github.com/upbound/up) + +Start by creating a namespace for Crossplane: + +```console +kubectl create namespace crossplane-system ``` -up ctp provider install opentelekomcloud/provider-opentelekomcloud:v0.1.0 + +Next, add the Crossplane Helm repository and update it: + +```console +helm repo add crossplane-stable https://charts.crossplane.io/stable +helm repo update ``` -Alternatively, you can use declarative installation: +Finally, install Crossplane using Helm: + +```console +helm install crossplane --namespace crossplane-system crossplane-stable/crossplane ``` + +After installation, verify that Crossplane is running correctly: + +```console +helm list -n crossplane-system +``` + +```console +kubectl get all -n crossplane-system +``` + +#### Install the Provider + +Install the provider by using the following command after changing the image tag to the [latest release](https://marketplace.upbound.io/providers/opentelekomcloud/provider-opentelekomcloud): + +```console +up ctp provider install opentelekomcloud/provider-opentelekomcloud:v0.3.0 +``` + +Alternatively, you can use declarative installation: + +```console cat <