Merge pull request #124 from spinkube/feature/crd-reference

Add CRD reference docs

.github/workflows/deploy.yaml

@@ -19,6 +19,7 @@ concurrency:
 
 env:
   CANONICAL_DOMAIN: www.spinkube.dev
+  SPIN_OPERATOR_RELEASE: v0.1.0
 
 jobs:
   # TODO: place into separate build.yaml (and add PR support?) and then call here?
@@ -42,6 +43,13 @@ jobs:
       - name: Install Node.js dependencies
         run: npm install
 
+      - name: Generate CRD reference docs
+        run: ./generate.sh
+        with:
+          path: ./crd-reference
+        env:
+          SPIN_OPERATOR_RELEASE: ${{ env.SPIN_OPERATOR_RELEASE }}
+
       - name: Build
         run: |
           hugo \

content/en/docs/spin-operator/reference/_index.md

@@ -0,0 +1,7 @@
+---
+title: Reference
+description: Reference documentation for Custom Resource Definitions (CRDs)
+weight: 3
+categories: [Spin Operator]
+tags: [reference]
+---

content/en/docs/spin-operator/reference/spin-app-executor.md

@@ -0,0 +1,122 @@
+---
+title: SpinAppExecutor CRD Reference
+weight: 1
+description: Custom Resource Definition (CRD) reference for `SpinAppExecutor`
+categories: [Spin Operator]
+tags: [reference]
+---
+Resource Types:
+
+- [SpinAppExecutor](#spinappexecutor)
+
+## SpinAppExecutor
+
+SpinAppExecutor is the Schema for the spinappexecutors API
+
+<table>
+    <thead>
+        <tr>
+            <th>Name</th>
+            <th>Type</th>
+            <th>Description</th>
+            <th>Required</th>
+        </tr>
+    </thead>
+    <tbody><tr>
+      <td><b>apiVersion</b></td>
+      <td>string</td>
+      <td>core.spinoperator.dev/v1alpha1</td>
+      <td>true</td>
+      </tr>
+      <tr>
+      <td><b>kind</b></td>
+      <td>string</td>
+      <td>SpinAppExecutor</td>
+      <td>true</td>
+      </tr>
+      <tr>
+      <td><b><a href="https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta">metadata</a></b></td>
+      <td>object</td>
+      <td>Refer to the Kubernetes API documentation for the fields of the `metadata` field.</td>
+      <td>true</td>
+      </tr><tr>
+        <td><b><a href="#spinappexecutorspec">spec</a></b></td>
+        <td>object</td>
+        <td>
+          SpinAppExecutorSpec defines the desired state of SpinAppExecutor<br/>
+        </td>
+        <td>false</td>
+      </tr><tr>
+        <td><b>status</b></td>
+        <td>object</td>
+        <td>
+          SpinAppExecutorStatus defines the observed state of SpinAppExecutor<br/>
+        </td>
+        <td>false</td>
+      </tr></tbody>
+</table>
+
+
+### `SpinAppExecutor.spec` 
+<small>[back to parent](#spinappexecutor)</small>
+
+
+SpinAppExecutorSpec defines the desired state of SpinAppExecutor
+
+<table>
+    <thead>
+        <tr>
+            <th>Name</th>
+            <th>Type</th>
+            <th>Description</th>
+            <th>Required</th>
+        </tr>
+    </thead>
+    <tbody><tr>
+        <td><b>createDeployment</b></td>
+        <td>boolean</td>
+        <td>
+          CreateDeployment specifies whether the Executor wants the SpinKube operator
+to create a deployment for the application or if it will be realized externally.<br/>
+        </td>
+        <td>true</td>
+      </tr><tr>
+        <td><b><a href="#spinappexecutorspecdeploymentconfig">deploymentConfig</a></b></td>
+        <td>object</td>
+        <td>
+          DeploymentConfig specifies how the deployment should be configured when
+createDeployment is true.<br/>
+        </td>
+        <td>false</td>
+      </tr></tbody>
+</table>
+
+
+### `SpinAppExecutor.spec.deploymentConfig` 
+<small>[back to parent](#spinappexecutorspec)</small>
+
+
+DeploymentConfig specifies how the deployment should be configured when
+createDeployment is true.
+
+<table>
+    <thead>
+        <tr>
+            <th>Name</th>
+            <th>Type</th>
+            <th>Description</th>
+            <th>Required</th>
+        </tr>
+    </thead>
+    <tbody><tr>
+        <td><b>runtimeClassName</b></td>
+        <td>string</td>
+        <td>
+          RuntimeClassName is the runtime class name that should be used by pods created
+as part of a deployment.<br/>
+        </td>
+        <td>true</td>
+      </tr></tbody>
+</table>
+
+