Skip to content

Commit

Permalink
docs: improve readme (#11)
Browse files Browse the repository at this point in the history
  • Loading branch information
scraly authored Feb 1, 2024
1 parent 237366a commit 7dd7533
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,16 @@ is built using [Upjet](https://github.com/crossplane/upjet) code
generation tools and exposes XRM-conformant managed resources for the
OVH API.

## Prerequisites

* Install [up CLI](https://github.com/upbound/up?tab=readme-ov-file#install)
* Install [Crossplane in your cluster](https://docs.crossplane.io/latest/software/install/)

## Getting Started

Install the provider by using the following command after changing the image tag
to the [latest release](https://marketplace.upbound.io/providers/edixos/provider-ovh):
Install the provider by using the following command:
```
up ctp provider install edixos/provider-ovh:v0.1.0
up ctp provider install edixos/provider-ovh
```

Alternatively, you can use declarative installation:
Expand All @@ -21,10 +25,15 @@ kind: Provider
metadata:
name: provider-ovh
spec:
package: edixos/provider-ovh:v0.1.0
package: edixos/provider-ovh
EOF
```

If you want to specify a version of the provider, add an image tag
to the [latest release](https://marketplace.upbound.io/providers/edixos/provider-ovh).
Example:
`edixos/provider-ovh:v.0.1.4`

Notice that in this example Provider resource is referencing ControllerConfig with debug enabled.

You can see the API reference [here](https://doc.crds.dev/github.com/edixos/provider-ovh).
Expand Down

0 comments on commit 7dd7533

Please sign in to comment.