https://github.com/tomy2e/cluster-api-provider-scaleway
Cluster API infrastructure provider for Scaleway
https://github.com/tomy2e/cluster-api-provider-scaleway
cluster-api scaleway
Last synced: about 1 month ago
JSON representation
Cluster API infrastructure provider for Scaleway
- Host: GitHub
- URL: https://github.com/tomy2e/cluster-api-provider-scaleway
- Owner: Tomy2e
- License: mit
- Created: 2023-01-20T17:51:26.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-12T17:02:42.000Z (3 months ago)
- Last Synced: 2025-03-26T09:42:35.408Z (2 months ago)
- Topics: cluster-api, scaleway
- Language: Go
- Homepage:
- Size: 291 KB
- Stars: 1
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cluster-api-provider-scaleway
⚠ This is currently a proof-of-concept. Do NOT use in production! ⚠
As this is still an early release, the current API is NOT guaranteed to be stable.
Things will break in the first releases, be prepared for it.
Do not hesitate to contribute by opening issues/pull requests.
## Description
// TODO(user): An in-depth paragraph about your project and overview of use
## Getting Started
### Prerequisites
- go version v1.22.0+
- docker version 17.03+.
- kubectl version v1.11.3+.
- Access to a Kubernetes v1.11.3+ cluster.
### To Deploy on the cluster
**Build and push your image to the location specified by `IMG`:**
```sh
make docker-build docker-push IMG=/cluster-api-provider-scaleway:tag
```
**NOTE:** This image ought to be published in the personal registry you specified.
And it is required to have access to pull the image from the working environment.
Make sure you have the proper permission to the registry if the above commands don’t work.
**Install the CRDs into the cluster:**
```sh
make install
```
**Deploy the Manager to the cluster with the image specified by `IMG`:**
```sh
make deploy IMG=/cluster-api-provider-scaleway:tag
```
> **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin
privileges or be logged in as admin.
**Create instances of your solution**
You can apply the samples (examples) from the config/sample:
```sh
kubectl apply -k config/samples/
```
>**NOTE**: Ensure that the samples has default values to test it out.
### To Uninstall
**Delete the instances (CRs) from the cluster:**
```sh
kubectl delete -k config/samples/
```
**Delete the APIs(CRDs) from the cluster:**
```sh
make uninstall
```
**UnDeploy the controller from the cluster:**
```sh
make undeploy
```
## Project Distribution
Following are the steps to build the installer and distribute this project to users.
1. Build the installer for the image built and published in the registry:
```sh
make build-installer IMG=/cluster-api-provider-scaleway:tag
```
NOTE: The makefile target mentioned above generates an 'install.yaml'
file in the dist directory. This file contains all the resources built
with Kustomize, which are necessary to install this project without
its dependencies.
2. Using the installer
Users can just run kubectl apply -f to install the project, i.e.:
```sh
kubectl apply -f https://raw.githubusercontent.com//cluster-api-provider-scaleway//dist/install.yaml
```
## Contributing
// TODO(user): Add detailed information on how you would like others to contribute to this project
**NOTE:** Run `make help` for more information on all potential `make` targets
More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)