Add develop doc (#36)

Signed-off-by: michal.gubricky <[email protected]>

Author: michal-gubricky

.envrc.sample

@@ -0,0 +1,12 @@
+export KUBECONFIG=$PWD/.mgt-cluster-kubeconfig.yaml
+export K8S_VERSION=1-27
+export GIT_PROVIDER_B64=Z2l0aHVi
+export GIT_ACCESS_TOKEN_B64=mybase64encodedtoken
+export GIT_ORG_NAME_B64=U292ZXJlaWduQ2xvdWRTdGFjaw==
+export GIT_REPOSITORY_NAME_B64=Y2x1c3Rlci1zdGFja3M=
+export EXP_CLUSTER_RESOURCE_SET=true
+export EXP_MACHINE_POOL=true
+export CLUSTER_TOPOLOGY=true
+export EXP_RUNTIME_SDK=true
+export EXP_MACHINE_SET_PREFLIGHT_CHECKS=true
+export CLUSTER_NAME=test-dfkhje

docs/develop.md

@@ -0,0 +1,61 @@
+# Develop Cluster Stack Provider OpenStack
+
+Developing our operator is quite straightforward. First, you need to install some basic prerequisites:
+
+- Docker
+- Go
+
+Next, configure your environment variables. Once that's done, you can initiate development using the local Kind cluster and the Tilt UI to create a workload cluster that comes pre-configured.
+
+## Setting Tilt up
+
+1. Install Docker and Go. We expect you to run on a Linux OS.
+2. Create an `.envrc` file and specify the values you need. See the `.envrc.sample` for details.
+
+## Developing with Tilt
+
+![tilt](./pics/tilt.png "Tilt")
+
+Operator development requires a lot of iteration, and the “build, tag, push, update deployment” workflow can be very tedious. Tilt makes this process much simpler by watching for updates and automatically building and deploying them. To build a kind cluster and to start Tilt, run:
+
+```shell
+make tilt-up
+```
+
+> To access the Tilt UI please go to: `http://localhost:10351`
+
+You should make sure that everything in the UI looks green. If not, you can trigger the Tilt workflow again. To establish a connection to your OpenStack project, you must supply a secret containing the `clouds.yaml` file.
+
+```bash
+kubectl create secret generic <my-secret> --from-file=clouds.yaml=path/to/clouds.yaml -n cluster
+```
+
+To transfer the credentials stored in the secret mentioned above to the operator, the user must create an `OpenStackClusterStackReleaseTemplate` object and specify this secret in the `identityRef` field. The `clouds.yaml` file may contain one or more clouds, so the user must specify desired connection to a specific cloud by using the `cloudName` field. Refer to the `examples/cspotemplate.yaml` file for more details. Afterward, apply this template to the local Kind cluster, which was built by the previous `make` command.
+
+```bash
+kubectl apply -f <path-to-openstack-clusterstack-release-template>
+```
+
+Now, proceed to apply the `ClusterStack` to the local Kind cluster. For more details see `examples/clusterstack.yaml`.
+
+```bash
+kubectl apply -f <path-to-openstack-clusterstack>
+```
+
+Please be patient and wait for the operator to execute the necessary tasks. In case your `ClusterStack` object encounters no errors and `openstacknodeimagereleases` is ready, you can deploy a workload cluster. This could be done by applying cluster-template. See the example of this template in `examples/cluster.yaml`.
+
+```bash
+kubectl apply -f <path-to-cluster-template>
+```
+
+In case you want to change some code, you can do so and see that Tilt triggers on save. It will update the container of the operator automatically.
+
+To tear down the workload cluster press the "Delete Workload Cluster" button. After a few minutes, the resources should be deleted.
+
+To tear down the kind cluster, use:
+
+```shell
+make delete-bootstrap-cluster
+```
+
+If you have any trouble finding the right command, then you can use `make help` to get a list of all available make targets.

docs/pics/tilt.png

@@ -0,0 +1,27 @@
+apiVersion: cluster.x-k8s.io/v1beta1
+kind: Cluster
+metadata:
+  name: <my-workload-cluster-name>
+  namespace: cluster
+spec:
+  clusterNetwork:
+    services:
+      cidrBlocks: ["10.128.0.0/12"]
+    pods:
+      cidrBlocks: ["192.168.0.0/16"]
+    serviceDomain: "cluster.local"
+  topology:
+    class: openstack-ferrol-1-27-v1
+    controlPlane:
+      metadata: {}
+      replicas: 1
+    variables:
+      - name: imageRepository
+        value: ""
+    version: v1.27.3
+    workers:
+      machineDeployments:
+        - class: workeramd64
+          name: md-0
+          replicas: 1
+          failureDomain: nova

examples/cluster.yaml

@@ -0,0 +1,17 @@
+apiVersion: clusterstack.x-k8s.io/v1alpha1
+kind: ClusterStack
+metadata:
+  name: clusterstack
+  namespace: cluster
+spec:
+  provider: openstack
+  name: ferrol
+  kubernetesVersion: "1.27"
+  channel: stable
+  autoSubscribe: false
+  providerRef:
+    apiVersion: infrastructure.clusterstack.x-k8s.io/v1alpha1
+    kind: OpenStackClusterStackReleaseTemplate
+    name: cspotemplate
+  versions:
+    - v1

examples/clusterstack.yaml

@@ -0,0 +1,12 @@
+apiVersion: infrastructure.clusterstack.x-k8s.io/v1alpha1
+kind: OpenStackClusterStackReleaseTemplate
+metadata:
+  name: cspotemplate
+  namespace: cluster
+spec:
+  template:
+    spec:
+      cloudName: <name of the cloud to use from the clouds secret>
+      identityRef:
+        kind: Secret
+        name: <my-secret>