-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This commit adds reference docs for CRDs provided by Spin Operator. Reference documentation is generated based on CRDs published as part of the spin-operator release. Signed-off-by: Thorsten Hans <thorsten.hans@fermyon.com>
- Loading branch information
1 parent
2dd2a0d
commit 709e061
Showing
10 changed files
with
5,458 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
--- | ||
title: Reference | ||
description: Reference documentation for Custom Resource Definitions (CRDs) | ||
weight: 3 | ||
categories: [Spin Operator] | ||
tags: [reference] | ||
--- |
122 changes: 122 additions & 0 deletions
122
content/en/docs/spin-operator/reference/spin-app-executor.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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> | ||
|
||
|
Oops, something went wrong.