https://github.com/ionos-cloud/crossplane-provider-ionoscloud
The Crossplane Provider for IONOS Cloud gives the ability to manage IONOS Cloud infrastructure directly from Kubernetes.
https://github.com/ionos-cloud/crossplane-provider-ionoscloud
Last synced: 18 days ago
JSON representation
The Crossplane Provider for IONOS Cloud gives the ability to manage IONOS Cloud infrastructure directly from Kubernetes.
- Host: GitHub
- URL: https://github.com/ionos-cloud/crossplane-provider-ionoscloud
- Owner: ionos-cloud
- License: apache-2.0
- Created: 2022-01-26T11:33:45.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-03-25T19:36:36.000Z (about 1 year ago)
- Last Synced: 2024-03-25T22:33:35.948Z (about 1 year ago)
- Language: Go
- Homepage:
- Size: 1.5 MB
- Stars: 12
- Watchers: 4
- Forks: 3
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/ionos-cloud/crossplane-provider-ionoscloud/actions)
[](https://github.com/ionos-cloud/crossplane-provider-ionoscloud/actions)
[](https://gitter.im/ionos-cloud/sdk-general)
[](https://sonarcloud.io/summary/new_code?id=crossplane-provider-ionoscloud)
[](https://sonarcloud.io/dashboard?id=crossplane-provider-ionoscloud)
[](https://sonarcloud.io/dashboard?id=crossplane-provider-ionoscloud)
[](https://sonarcloud.io/dashboard?id=crossplane-provider-ionoscloud)
[](https://sonarcloud.io/dashboard?id=crossplane-provider-ionoscloud)
[](https://sonarcloud.io/dashboard?id=crossplane-provider-ionoscloud)
[](https://github.com/ionos-cloud/crossplane-provider-ionoscloud/releases/latest)
[](https://github.com/ionos-cloud/crossplane-provider-ionoscloud/releases/latest)
[](https://github.com/ionos-cloud/crossplane-provider-ionoscloud)
# Crossplane Provider IONOS Cloud
---
## Overview
This `crossplane-provider-ionoscloud` repository is the Crossplane infrastructure provider for IONOS Cloud. The provider
that is built from the source code from this repository can be installed into a Crossplane control plane and adds the
following new functionality:
* Custom Resource Definitions (CRDs) that model IONOS Cloud infrastructure and services (e.g. Database As a Service
Postgres, Compute Engine, Kubernetes, etc.)
* Controllers to provision these resources in IONOS Cloud based on the users desired state captured in CRDs they create
* Implementations of Crossplane portable resource abstractions, enabling IONOS Cloud resources to fulfill a user's
general need for cloud services
## Getting Started and Documentation
For getting started with Crossplane Provider IONOS Cloud, check out this step-by-step [example](examples/example.md).
## Set up Crossplane Provider IONOS Cloud
In order to set up Crossplane Provider IONOS Cloud, see details
in [here](examples/example.md#setup-crossplane-provider-ionos-cloud).
## Authentication on IONOS Cloud
Crossplane Provider IONOS Cloud uses [ProviderConfig](examples/provider/config.yaml) in order to setup credentials via
secrets. You can use environments variables when creating the `ProviderConfig` resource.
| Environment Variable | Description |
|----------------------|--------------------------------------------------------------------------------------------|
| `IONOS_USERNAME` | Specify the username used to login, to authenticate against the IONOS Cloud API |
| `IONOS_PASSWORD` | Specify the password used to login, to authenticate against the IONOS Cloud API |
| `IONOS_TOKEN` | Specify the token used to login, if a token is being used instead of username and password |
| `IONOS_API_URL` | Specify the API URL. It will overwrite the API endpoint default value `api.ionos.com` | |
| `IONOS_LOG_LEVEL` | Specify the Log Level used to log messages. Possible values: `Off`, `Debug`, `Trace` |
| `IONOS_PINNED_CERT` | Specify the SHA-256 public fingerprint here, enables certificate pinning | |
⚠️ **_Note: We recommend you only set this `TRACE` for debugging purposes. Disable it in your production environments because it can log sensitive data.
It logs the full request and response without encryption, even for an HTTPS call.
Verbose request and response logging can also significantly impact your application's performance._**
## Certificate pinning:
You can enable certificate pinning if you want to bypass the normal certificate checking procedure,
by doing the following:
You can get the sha256 fingerprint most easily from the browser by inspecting the certificate test.
Apply the following crds. They will install the latest ionos provider with the pinned certificate enabled.
```bash
apiVersion: pkg.crossplane.io/v1
kind: Provider
metadata:
name: provider-ionos
spec:
package: ghcr.io/ionos-cloud/crossplane-provider-ionoscloud:latest
runtimeConfigRef:
name: enable-pinning
---
apiVersion: pkg.crossplane.io/v1beta1
kind: DeploymentRuntimeConfig
metadata:
name: enable-pinning
spec:
deploymentTemplate:
spec:
selector: {}
template:
spec:
containers:
- name: package-runtime
env:
- name: IONOS_PINNED_CERT
value: "pinned_cert_here"
```
More details about ProviderConfig and authentication [here](docs/README.md#authentication-on-ionos-cloud).
## Provision Resources on IONOS Cloud
Crossplane Provider IONOS Cloud Managed Resources list is available [here](docs/RESOURCES.md).
## Build images
For building Docker images, use:
```bash
make build
```
A version can be set via `$VERSION` variable. By running `make build VERSION=v0.x.x`, the specified version will be
added into the `package/crossplane.yaml`.
For tagging Docker images, use:
```bash
make docker.tag VERSION=v0.x.x
```
## Usage
To run a K8s Cluster and install Crossplane:
```bash
make dev
```
To run e2e tests:
```bash
make e2e
```
To run linters on the code before opening a PR:
```bash
make reviewable
```
To clean up the K8s Cluster:
```bash
make dev-clean
```
To list all available options:
```bash
make help
```
## Testing
Crossplane Provider IONOS Cloud has end-to-end integration tests for the resources supported.
For running end-to-end integration tests locally, use:
```bash
make e2e
```
If the images have a specific version, other than `latest`, this can be set via `make e2e VERSION=v0.x.x`.
Daily workflows with all end-to-end integration tests are running using GitHub Actions. You can check their
status [here](https://github.com/ionos-cloud/crossplane-provider-ionoscloud/actions/workflows/ci-daily.yml).
## Releases
Releases can be made on Crossplane Provider IONOS Cloud via tags or manual action of the CD workflow. The CD workflow
will test and release the images. It will release images for controller and provider, with 2 tags each: `latest` and the
corresponding release tag.
## Contributing
`crossplane-provider-ionoscloud` is a community driven project and we welcome contributions. See the Crossplane
[Contributing](https://github.com/crossplane/crossplane/blob/master/CONTRIBUTING.md) guidelines to get started.
### Adding New Resource
New resources can be added by defining the required types in `apis` and the controllers `internal/controller/`.
If you are running crossplane for the first time, run:
```bash
make submodules
```
To generate the CRDs YAML files run:
```bash
make generate
```
## Report a Bug
For filing bugs, suggesting improvements, or requesting new features, please open
an [issue](https://github.com/ionos-cloud/crossplane-provider-ionoscloud/issues).
## Code of Conduct
`crossplane-provider-ionoscloud` adheres to the
same [Code of Conduct](https://github.com/crossplane/crossplane/blob/master/CODE_OF_CONDUCT.md) as the core Crossplane
project.
## License
crossplane-provider-ionoscloud is under the [Apache 2.0 License](LICENSE).