Skip to content

Add documentation templating #160

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.

Sign up for GitHub

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

Closed
wants to merge 4 commits into from
Closed

Add documentation templating #160

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
daea2d7
Added install document
fhennig Jul 25, 2022
da0e22e
moved file to correct dir
fhennig Jul 25, 2022
137d004
Updated instructions
fhennig Jul 25, 2022
43b5d30
Update template/docs/modules/getting_started/pages/install_the_operat…
fhennig Jul 25, 2022
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions template/docs/modules/getting_started/pages/install_the_operator.adoc.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
= Installation

There are 2 ways to run the {[ operator.pretty_string }] Operator:

1. Using xref:stackablectl::index.adoc[]

1. Using Helm

== stackablectl

stackablectl is the command line tool to interact with Stackable operators and our recommended way to install Operators.
Follow the xref:stackablectl::installation.adoc[installation steps] for your platform.

After the installation run to install the {[ operator.pretty_string }] Operator:

[source,bash]
----
stackablectl operator install {[ operator.product_string }]
----

The tool will show

----
[INFO ] Installing {[ operator.product_string }] operator
----

Consult the xref:stackablectl::quickstart.adoc[] to learn more about how to use stackablectl.

== Helm

You can also use Helm to install the Operator. Add the Stackable Helm repository:
[source,bash]
----
$ helm repo add stackable https://repo.stackable.tech/repository/helm-stable/
----

Then install the Stackable Operator for {[ operator.pretty_string }]
[source,bash]
----
$ helm install druid-operator stackable/{[ operator.name }]
----

Helm will deploy the operator in a Kubernetes container and apply the CRDs for the {[ operator.pretty_string }] service. You are now ready to deploy {[ operator.pretty_string }] in Kubernetes.