Skip to content

Commit eaee670

Browse files
Tomy2eTomy2e
committed
Update README.md
1 parent 6cc616f commit eaee670

File tree

3 files changed

+140
-98
lines changed

3 files changed

+140
-98
lines changed

‎README.md

Lines changed: 36 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -1,121 +1,59 @@
1-
# cluster-api-provider-scaleway
2-
// TODO(user): Add simple overview of use/purpose
1+
# Kubernetes Cluster API Provider Scaleway
32

4-
## Description
5-
// TODO(user): An in-depth paragraph about your project and overview of use
3+
> [!WARNING]
4+
> **This project is currently in its alpha stage**, which means it is still under active development.
5+
> As such, features are subject to change, and breaking changes may occur without notice.
6+
> We recommend using it with caution in production environments and keeping up to date
7+
> with the latest updates and documentation.
68
7-
## Getting Started
9+
------
810

9-
### Prerequisites
10-
- go version v1.23.0+
11-
- docker version 17.03+.
12-
- kubectl version v1.11.3+.
13-
- Access to a Kubernetes v1.11.3+ cluster.
11+
## What is the Cluster API Provider Scaleway (CAPS)
1412

15-
### To Deploy on the cluster
16-
**Build and push your image to the location specified by `IMG`:**
13+
The [Cluster API](https://github.com/kubernetes-sigs/cluster-api) brings declarative, Kubernetes-style APIs to cluster creation, configuration and management.
1714

18-
```sh
19-
make docker-build docker-push IMG=<some-registry>/cluster-api-provider-scaleway:tag
20-
```
15+
CAPS is a Cluster API infrastructure provider that enables efficient management at
16+
scale of self-managed clusters on Scaleway.
2117

22-
**NOTE:** This image ought to be published in the personal registry you specified.
23-
And it is required to have access to pull the image from the working environment.
24-
Make sure you have the proper permission to the registry if the above commands don’t work.
18+
## Quick Start
2519

26-
**Install the CRDs into the cluster:**
20+
Check out the [getting started](./docs/getting-started.md) to create your first
21+
Kubernetes cluster on Scaleway using Cluster API.
2722

28-
```sh
29-
make install
30-
```
23+
## Getting Help
3124

32-
**Deploy the Manager to the cluster with the image specified by `IMG`:**
25+
If you need help with CAPS, please visit the #cluster-api channel on
26+
[Scaleway Slack community](https://slack.scaleway.com/) or open a GitHub issue.
3327

34-
```sh
35-
make deploy IMG=<some-registry>/cluster-api-provider-scaleway:tag
36-
```
28+
------
3729

38-
> **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin
39-
privileges or be logged in as admin.
30+
## Compatibility
4031

41-
**Create instances of your solution**
42-
You can apply the samples (examples) from the config/sample:
32+
### Cluster API Versions
4333

44-
```sh
45-
kubectl apply -k config/samples/
46-
```
34+
Currently, CAPS is compatible only with the `v1beta1` version of CAPI (v1.0.x).
4735

48-
>**NOTE**: Ensure that the samples has default values to test it out.
36+
### Kubernetes Versions
4937

50-
### To Uninstall
51-
**Delete the instances (CRs) from the cluster:**
38+
The Scaleway provider is able to install and manage the [versions of Kubernetes supported by the Cluster API (CAPI) project](https://cluster-api.sigs.k8s.io/reference/versions.html#supported-kubernetes-versions).
5239

53-
```sh
54-
kubectl delete -k config/samples/
55-
```
40+
------
5641

57-
**Delete the APIs(CRDs) from the cluster:**
42+
## Getting involved and contributing
5843

59-
```sh
60-
make uninstall
61-
```
44+
Are you interested in contributing to cluster-api-provider-scaleway? We would love
45+
your suggestions, contributions, and help!
6246

63-
**UnDeploy the controller from the cluster:**
47+
To set up your environment checkout the [development guide](./docs/development.md).
6448

65-
```sh
66-
make undeploy
67-
```
49+
## Github issues
6850

69-
## Project Distribution
51+
### Bugs
7052

71-
Following the options to release and provide this solution to the users.
72-
73-
### By providing a bundle with all YAML files
74-
75-
1. Build the installer for the image built and published in the registry:
76-
77-
```sh
78-
make build-installer IMG=<some-registry>/cluster-api-provider-scaleway:tag
79-
```
80-
81-
**NOTE:** The makefile target mentioned above generates an 'install.yaml'
82-
file in the dist directory. This file contains all the resources built
83-
with Kustomize, which are necessary to install this project without its
84-
dependencies.
85-
86-
2. Using the installer
87-
88-
Users can just run 'kubectl apply -f <URL for YAML BUNDLE>' to install
89-
the project, i.e.:
90-
91-
```sh
92-
kubectl apply -f https://raw.githubusercontent.com/<org>/cluster-api-provider-scaleway/<tag or branch>/dist/install.yaml
93-
```
94-
95-
### By providing a Helm Chart
96-
97-
1. Build the chart using the optional helm plugin
98-
99-
```sh
100-
kubebuilder edit --plugins=helm/v1-alpha
101-
```
102-
103-
2. See that a chart was generated under 'dist/chart', and users
104-
can obtain this solution from there.
105-
106-
**NOTE:** If you change the project, you need to update the Helm Chart
107-
using the same command above to sync the latest changes. Furthermore,
108-
if you create webhooks, you need to use the above command with
109-
the '--force' flag and manually ensure that any custom configuration
110-
previously added to 'dist/chart/values.yaml' or 'dist/chart/manager/manager.yaml'
111-
is manually re-applied afterwards.
112-
113-
## Contributing
114-
// TODO(user): Add detailed information on how you would like others to contribute to this project
115-
116-
**NOTE:** Run `make help` for more information on all potential `make` targets
117-
118-
More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)
119-
120-
## License
53+
If you think you have found a bug please follow the instructions below.
12154

55+
- Please spend a small amount of time giving due diligence to the issue tracker. Your issue might be a duplicate.
56+
- Get the logs from the cluster controllers. Please paste this into your issue.
57+
- Open a new issue.
58+
- Remember users might be searching for your issue in the future, so please give it a meaningful title to help others.
59+
- Feel free to reach out to the #cluster-api channel on [Scaleway Slack community](https://slack.scaleway.com/)

‎docs/development.md

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# Development
2+
3+
## Getting Started
4+
5+
### Prerequisites
6+
7+
- go version v1.23.0+
8+
- docker version 17.03+.
9+
- kubectl version v1.11.3+.
10+
- Access to a Kubernetes v1.11.3+ cluster.
11+
- clusterctl version v1.10.2+
12+
13+
### To install Cluster API on the cluster
14+
15+
**Initialize cluster API using the `clusterctl` CLI:**
16+
17+
```sh
18+
clusterctl init
19+
```
20+
21+
### To Deploy on the cluster
22+
23+
**Build and push your image to the location specified by `IMG`:**
24+
25+
```sh
26+
make docker-build docker-push IMG=<some-registry>/cluster-api-provider-scaleway:tag
27+
```
28+
29+
**NOTE:** This image ought to be published in the personal registry you specified.
30+
And it is required to have access to pull the image from the working environment.
31+
Make sure you have the proper permission to the registry if the above commands don’t work.
32+
33+
**Install the CRDs into the cluster:**
34+
35+
```sh
36+
make install
37+
```
38+
39+
**Deploy the Manager to the cluster with the image specified by `IMG`:**
40+
41+
```sh
42+
make deploy IMG=<some-registry>/cluster-api-provider-scaleway:tag
43+
```
44+
45+
> **NOTE**: If you encounter RBAC errors, you may need to grant yourself cluster-admin
46+
privileges or be logged in as admin.
47+
48+
**Create instances of your solution**
49+
You can apply the samples (examples) from the config/sample:
50+
51+
```sh
52+
kubectl apply -k config/samples/
53+
```
54+
55+
>**NOTE**: Ensure that the samples has default values to test it out.
56+
57+
### To Uninstall
58+
59+
**Delete the instances (CRs) from the cluster:**
60+
61+
```sh
62+
kubectl delete -k config/samples/
63+
```
64+
65+
**Delete the APIs(CRDs) from the cluster:**
66+
67+
```sh
68+
make uninstall
69+
```
70+
71+
**UnDeploy the controller from the cluster:**
72+
73+
```sh
74+
make undeploy
75+
```
76+
77+
## Project Distribution
78+
79+
Following the options to release and provide this solution to the users.
80+
81+
### By providing a bundle with all YAML files
82+
83+
1. Build the installer for the image built and published in the registry:
84+
85+
```sh
86+
make build-installer IMG=<some-registry>/cluster-api-provider-scaleway:tag
87+
```
88+
89+
**NOTE:** The makefile target mentioned above generates an 'install.yaml'
90+
file in the dist directory. This file contains all the resources built
91+
with Kustomize, which are necessary to install this project without its
92+
dependencies.
93+
94+
2. Using the installer
95+
96+
Users can just run 'kubectl apply -f <URL for YAML BUNDLE>' to install
97+
the project, i.e.:
98+
99+
```sh
100+
kubectl apply -f https://raw.githubusercontent.com/<org>/cluster-api-provider-scaleway/<tag or branch>/dist/install.yaml
101+
```

‎docs/getting-started.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Getting started
2+
3+
WIP

0 commit comments

Comments
 (0)