diff --git a/README.md b/README.md index b8d4353..1dd05eb 100644 --- a/README.md +++ b/README.md @@ -2,37 +2,22 @@ The Spin Operator enables deploying Spin applications to Kubernetes. It watches [SpinApp Custom Resources](https://github.com/spinkube/documentation/blob/main/content/en/docs/spin-operator/reference/custom-resource-definition.md) and realizes the desired state in the Kubernetes cluster. This project was built using the Kubebuilder framework and contains a Spin App CRD and controller. -## Documentation - -To learn more about the Spin Operator and the SpinKube organization, please visit [the official Spin Operator documentation](https://github.com/spinkube/documentation/tree/main/content/en/docs/spin-operator) which is housed inside the [the official SpinKube documentation](https://github.com/spinkube/documentation/tree/main/content/en/docs). - -At this point in the preview, we recommend testing Spin Operator on a local k3d cluster via `make install`. The [quickstart guide](https://github.com/spinkube/documentation/blob/main/content/en/docs/spin-operator/quickstart/_index.md) will walk you through prequisites and the installation workflow. - -> > Spin Operator installation via Helm chart for remote clusters while in private preview is WIP and can tracked [here](https://github.com/spinkube/spin-operator/issues/54). In the meantime, please use the guidance from our quickstart guide. +To get started, check out the [Spin Operator quickstart](http://spinkube.dev/docs/spin-operator/quickstart/) -## Tutorials +![Conceptual Overview Diagram of Spin Operator](/static/image/spin-operator-diagram.png) -There are a host of tutorials in the [Spin Operator tutorials](https://github.com/spinkube/documentation/tree/main/content/en/docs/spin-operator/tutorials) directory of the documentation. For example: +## Documentation -- [Quickstart](https://github.com/spinkube/documentation/blob/main/content/en/docs/spin-operator/quickstart/_index.md) -- [Running Locally](https://github.com/spinkube/documentation/blob/main/content/en/docs/spin-operator/tutorials/running-locally.md) -- [Running on a remote (non-local) K8s cluster](https://github.com/spinkube/documentation/blob/main/content/en/docs/spin-operator/tutorials/running-on-a-cluster.md) -- [Deploying on Azure k8s service](https://github.com/spinkube/documentation/blob/main/content/en/docs/spin-operator/tutorials/deploy-on-azure-kubernetes-service.md) -- [Scaling Spin Apps with Horizontal Pod Autoscaler (HPA)](https://github.com/spinkube/documentation/blob/main/content/en/docs/spin-operator/tutorials/scaling-with-hpa.md) -- [Scaling Spin Apps with Kubernetes Event Driver Autoscaler (KEDA)](https://github.com/spinkube/documentation/blob/main/content/en/docs/spin-operator/tutorials/scaling-with-keda.md) +To learn more about the Spin Operator and the SpinKube organization, please visit [the official SpinKube documentation](https://spinkube.dev). ## Feedback The remaining articles are under construction. You're welcome to view and open both [Spin Operator](https://github.com/spinkube/spin-operator/issues) and [documentation](https://github.com/spinkube/documentation/issues) issues and feature requests. As this work is under development, please note that current features, functionality and supporting documentation are likely to change as the projects evolve and improvements are made. -For questions or support, please visit our [Discord channel](https://discord.com/channels/926888690310053918/1200012610196738208). - -## Contributing (Spin Operator) - -If you would like to contribute, please visit this [contributing](https://github.com/spinkube/documentation/blob/main/content/en/docs/spin-operator/contributing/_index.md) page. +For questions or support, please visit our [Slack channel](TODO). ## Contributing (Documentation) -If you would like to contribute to SpinKube and Spin Operator, please visit this [contributing](https://github.com/spinkube/documentation/blob/main/content/en/docs/contribution-guidelines/_index.md) page. +If you would like to contribute to SpinKube and Spin Operator, please visit this [documentation contributing](http://spinkube.dev/docs/contribution-guidelines/) page. -The documentation is written using Hugo (as the static site generator), Docsy (as the technical documentation template) and GitHub pages (for hosting). However, during construction (prior to the website being rendered and publicly available) you are welcome to run a local copy of the documentation using the `hugo server` command. You can do so by following [these instructions](https://github.com/spinkube/documentation/blob/main/content/en/docs/contribution-guidelines/_index.md#previewing-your-changes-locally). +>> The documentation is written using Hugo (as the static site generator), Docsy (as the technical documentation template) and GitHub pages (for hosting). However, during construction (prior to the website being rendered and publicly available) you are welcome to run a local copy of the documentation using the `hugo server` command. You can do so by following [these instructions](https://github.com/spinkube/documentation/blob/main/content/en/docs/contribution-guidelines/_index.md#previewing-your-changes-locally). diff --git a/config/manager/kustomization.yml b/config/manager/kustomization.yml index 2e6cc79..93b0050 100644 --- a/config/manager/kustomization.yml +++ b/config/manager/kustomization.yml @@ -1,2 +1,8 @@ resources: -- manager.yaml \ No newline at end of file +- manager.yaml +apiVersion: kustomize.config.k8s.io/v1beta1 +kind: Kustomization +images: +- name: ghcr.io/spinkube/spin-operator + newName: ghcr.io/spinkube/spin-operator + newTag: dev diff --git a/config/samples/cyclotron.yaml b/config/samples/cyclotron.yaml deleted file mode 100644 index 64aca21..0000000 --- a/config/samples/cyclotron.yaml +++ /dev/null @@ -1,8 +0,0 @@ -apiVersion: core.spinoperator.dev/v1 -kind: SpinApp -metadata: - name: cyclotron-spinapp -spec: - image: "public.ecr.aws/m8p2l5g2/cyclotron-demo-apps:hello" - replicas: 1 - executor: "cyclotron" diff --git a/static/image/spin-operator-diagram.png b/static/image/spin-operator-diagram.png new file mode 100644 index 0000000..f69fe3f Binary files /dev/null and b/static/image/spin-operator-diagram.png differ