Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change CRD domain to spinkube.dev #240

Merged
merged 2 commits into from
Nov 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/en/docs/contrib/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator
command:

```console
Error from server (InternalError): error when creating "https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.shim-executor.yaml": Internal error occurred: failed calling webhook "mspinappexecutor.kb.io": failed to call webhook: Post "https://spin-operator-webhook-service.spin-operator.svc:443/mutate-core-spinoperator-dev-v1alpha1-spinappexecutor?timeout=10s": no endpoints available for service "spin-operator-webhook-service"
Error from server (InternalError): error when creating "https://github.com/spinkube/spin-operator/releases/download/v0.3.0/spin-operator.shim-executor.yaml": Internal error occurred: failed calling webhook "mspinappexecutor.kb.io": failed to call webhook: Post "https://spin-operator-webhook-service.spin-operator.svc:443/mutate-core-spinkube-dev-v1alpha1-spinappexecutor?timeout=10s": no endpoints available for service "spin-operator-webhook-service"
```

To address the error above, first look to see if Spin Operator is running:
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ SpinApp CRD consists of several key fields that define the desired state of a Sp
Here's an example of a SpinApp custom resource that uses the SpinApp CRD schema:

```yaml
apiVersion: core.spinoperator.dev/v1alpha1
apiVersion: core.spinkube.dev/v1alpha1
kind: SpinApp
metadata:
name: simple-spinapp
Expand All @@ -91,7 +91,7 @@ You can modify the example above to customize the SpinApp via a YAML file. Here'
file with additional customization options:

```yaml
apiVersion: core.spinoperator.dev/v1alpha1
apiVersion: core.spinkube.dev/v1alpha1
kind: SpinApp
metadata:
name: simple-spinapp
Expand Down
10 changes: 5 additions & 5 deletions content/en/docs/install/linode-kubernetes-engine.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ $ spin kube scaffold --from ghcr.io/spinkube/containerd-shim-spin/examples/spin-
This will write the following to `hello-world.yaml`:

```yaml
apiVersion: core.spinoperator.dev/v1alpha1
apiVersion: core.spinkube.dev/v1alpha1
kind: SpinApp
metadata:
name: spin-rust-hello
Expand All @@ -128,7 +128,7 @@ Using `kubectl apply`, we can deploy that app:

```console
$ kubectl apply -f hello-world.yaml
spinapp.core.spinoperator.dev/spin-rust-hello created
spinapp.core.spinkube.dev/spin-rust-hello created
```

With SpinKube, SpinApps will be deployed as `Pod` resources, so we can see the app using `kubectl
Expand Down Expand Up @@ -157,7 +157,7 @@ metadata:
annotations:
service.beta.kubernetes.io/linode-loadbalancer-throttle: "4"
labels:
core.spinoperator.dev/app-name: spin-rust-hello
core.spinkube.dev/app-name: spin-rust-hello
spec:
type: LoadBalancer
ports:
Expand All @@ -166,7 +166,7 @@ spec:
protocol: TCP
targetPort: 80
selector:
core.spinoperator.dev/app.spin-rust-hello.status: ready
core.spinkube.dev/app.spin-rust-hello.status: ready
sessionAffinity: None
```

Expand Down Expand Up @@ -209,7 +209,7 @@ To delete this sample app, we will first delete the NodeBalancer, and then delet
$ kubectl delete service spin-rust-hello-nodebalancer
service "spin-rust-hello-nodebalancer" deleted
$ kubectl delete spinapp spin-rust-hello
spinapp.core.spinoperator.dev "spin-rust-hello" deleted
spinapp.core.spinkube.dev "spin-rust-hello" deleted
```

> If you delete the NodeBalancer out of the Linode console, it will not automatically delete the
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/install/microk8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ $ microk8s kubectl apply -f https://raw.githubusercontent.com/spinkube/spin-oper
The above installs a simple `SpinApp` YAML that looks like this:

```yaml
apiVersion: core.spinoperator.dev/v1alpha1
apiVersion: core.spinkube.dev/v1alpha1
kind: SpinApp
metadata:
name: simple-spinapp
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/install/rancher-desktop.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Replace `ttl.sh/hello-k3s:0.1.0` with your registry URL and tag.
```bash
$ spin kube scaffold --from ttl.sh/hello-k3s:0.1.0

apiVersion: core.spinoperator.dev/v1alpha1
apiVersion: core.spinkube.dev/v1alpha1
kind: SpinApp
metadata:
name: hello-k3s
Expand Down
29 changes: 20 additions & 9 deletions content/en/docs/reference/spin-app-executor.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ SpinAppExecutor is the Schema for the spinappexecutors API
<tbody><tr>
<td><b>apiVersion</b></td>
<td>string</td>
<td>core.spinoperator.dev/v1alpha1</td>
<td>core.spinkube.dev/v1alpha1</td>
<td>true</td>
</tr>
<tr>
Expand Down Expand Up @@ -109,14 +109,6 @@ createDeployment is true.
</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><tr>
<td><b>caCertSecret</b></td>
<td>string</td>
<td>
Expand All @@ -141,6 +133,25 @@ defined in `CACertSecret` the secret name will be `spin-ca`.<br/>
Otel provides Kubernetes Bindings to Otel Variables.<br/>
</td>
<td>false</td>
</tr><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. This should only be defined when SpintainerImage is not defined.<br/>
</td>
<td>false</td>
</tr><tr>
<td><b>spinImage</b></td>
<td>string</td>
<td>
SpinImage points to an image that will run Spin in a container to execute
your SpinApp. This is an alternative to using the shim to execute your
SpinApp. This should only be defined when RuntimeClassName is not
defined. When specified, application images must be available without
authentication.<br/>
</td>
<td>false</td>
</tr></tbody>
</table>

Expand Down
Loading