https://github.com/vshn/provider-exoscale

Crossplane provider for Exoscale
https://github.com/vshn/provider-exoscale

crossplane crossplane-provider exoscale vshn-project-ignore

Last synced: 6 months ago
JSON representation

Crossplane provider for Exoscale

• Host: GitHub
• URL: https://github.com/vshn/provider-exoscale
• Owner: vshn
• License: bsd-3-clause
• Created: 2022-07-26T13:51:31.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-05-28T17:03:57.000Z (about 1 year ago)
• Last Synced: 2024-05-28T21:25:52.645Z (about 1 year ago)
• Topics: crossplane, crossplane-provider, exoscale, vshn-project-ignore
• Language: Go
• Homepage:
• Size: 1.36 MB
• Stars: 3
• Watchers: 6
• Forks: 3
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# provider-exoscale

[![Build](https://img.shields.io/github/workflow/status/vshn/provider-exoscale/Test)][build]

![Go version](https://img.shields.io/github/go-mod/go-version/vshn/provider-exoscale)

[![Version](https://img.shields.io/github/v/release/vshn/provider-exoscale)][releases]

[![GitHub downloads](https://img.shields.io/github/downloads/vshn/provider-exoscale/total)][releases]

[build]: https://github.com/vshn/provider-exoscale/actions?query=workflow%3ATest

[releases]: https://github.com/vshn/provider-exoscale/releases

Crossplane provider for managing resources on exoscale.com.

Documentation: https://vshn.github.io/provider-exoscale/

## Local Development

### Requirements

* `docker`

* `go`

* `helm`

* `kubectl`

* `yq`

* `sed` (or `gsed` for Mac)

Some other requirements (e.g. `kind`) will be compiled on-the-fly and put in the local cache dir `.kind` as needed.

### Common make targets

* `make build` to build the binary and docker image

* `make generate` to (re)generate additional code artifacts

* `make test` run test suite

* `make local-install` to install the operator in local cluster

* `make install-samples` to run the provider in local cluster and apply sample manifests

* `make run-operator` to run the code in operator mode against your current kubecontext

See all targets with `make help`

### QuickStart Demonstration

1. Get an API token exoscale.com

2. `export EXOSCALE_API_KEY=`

3. `export EXOSCALE_API_SECRET=`

4. `make local-install`

### Kubernetes Webhook Troubleshooting

The provider comes with mutating and validation admission webhook server.

1. `make local-debug`

2.  Set the right host ip:

    ```bash

    HOSTIP=$(docker inspect kindev-control-plane | jq '.[0].NetworkSettings.Networks.kind.Gateway') # On kind MacOS/Windows

    HOSTIP=host.docker.internal # On Docker Desktop distributions

    HOSTIP=host.lima.internal # On Lima backed Docker distributions

    For Linux users: `ip -4 addr show dev docker0 | grep inet | awk -F' ' '{print $2}' | awk -F'/' '{print $1}'`

    ```

    

3.  Get an Exoscale API secret and key and create the following secret:

    ```bash

    EXOSCALE_API_KEY=

    EXOSCALE_API_SECRET=

    kubectl -n crossplane-system create secret generic api-secret-1 --from-literal=EXOSCALE_API_KEY="$EXOSCALE_API_KEY" --from-literal=EXOSCALE_API_SECRET="$EXOSCALE_API_SECRET"

    ```

4.  Run the debug target:

    ```bash

    make webhook-debug -e webhook_service_name=$HOSTIP

    ```

5.  Run the operator from IDE in debug mode with env variable:

    ```bash

    WEBHOOK_TLS_CERT_DIR=.kind # or full path if does not work

    ```    

### Crossplane Provider Mechanics

For detailed information on how Crossplane Provider works from a development perspective check [provider mechanics documentation page](https://kb.vshn.ch/app-catalog/explanations/crossplane_provider_mechanics.html).

### e2e testing with kuttl

Some scenarios are tested with the Kubernetes E2E testing tool [Kuttl](https://kuttl.dev/docs).

Kuttl is basically comparing the installed manifests (usually files named `##-install*.yaml`) with observed objects and compares the desired output (files named `##-assert*.yaml`).

To execute tests, run `make test-e2e` from the root dir.

If a test fails, kuttl leaves the resources in the kind-cluster intact, so you can inspect the resources and events if necessary.

Please note that Kubernetes Events from cluster-scoped resources appear in the `default` namespace only, but `kubectl describe ...` should show you the events.

If tests succeed, the relevant resources are deleted to not use up costs on the cloud providers.

### Cleaning up e2e tests

Usually `make clean` ensures that buckets and users are deleted before deleting the kind cluster, provided the operator is running in kind cluster.

Alternatively, `make .e2e-test-clean` also removes all `buckets` and `iamkeys`.

To cleanup manually on portal.exoscale.com, search for resources that begin with or contain `e2e` in the name.