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
refreshed spin operator readme #143
Closed
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -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. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
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). |
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 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@@ -1,2 +1,8 @@ | ||||||||||||||
resources: | ||||||||||||||
- manager.yaml | ||||||||||||||
- 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 | ||||||||||||||
Comment on lines
+3
to
+8
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
(this bit is unique to you when you |
This file was deleted.
Oops, something went wrong.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should remove "documentation" from the caption of the link