Skip to content

Commit

Permalink
Document how to deploy with a custom ingress
Browse files Browse the repository at this point in the history
  • Loading branch information
tamasmak committed Oct 1, 2024
1 parent 5f7d95a commit 1032b27
Showing 1 changed file with 43 additions and 1 deletion.
44 changes: 43 additions & 1 deletion articles/control-center/getting-started/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ Also, you'll need to install https://helm.sh/[Helm]. It's a Kubernetes package m

== Deploying Control Center

To deploy Control Center to your Kubernetes cluster, run the following Helm command:
To deploy Control Center to your Kubernetes cluster, run one of the following Helm commands.

=== Development environment

Check warning on line 24 in articles/control-center/getting-started/index.adoc

View workflow job for this annotation

GitHub Actions / lint

[vale] reported by reviewdog 🐶 [Vaadin.HeadingCase] 'Development environment' should be in title case. Raw Output: {"message": "[Vaadin.HeadingCase] 'Development environment' should be in title case.", "location": {"path": "articles/control-center/getting-started/index.adoc", "range": {"start": {"line": 24, "column": 5}}}, "severity": "WARNING"}

.Terminal
[source,bash]
Expand All @@ -37,8 +39,48 @@ helm install control-center oci://docker.io/vaadin/control-center \ // <1>
<4> Configures service settings for a load balancer on port `8000`. Change the port if necessary for your environment.
<5> This says for Helm to wait until Control Center is fully deployed.

=== Production environment

Check warning on line 42 in articles/control-center/getting-started/index.adoc

View workflow job for this annotation

GitHub Actions / lint

[vale] reported by reviewdog 🐶 [Vaadin.HeadingCase] 'Production environment' should be in title case. Raw Output: {"message": "[Vaadin.HeadingCase] 'Production environment' should be in title case.", "location": {"path": "articles/control-center/getting-started/index.adoc", "range": {"start": {"line": 42, "column": 5}}}, "severity": "WARNING"}

.Terminal
[source,bash]
----
helm install control-center oci://docker.io/vaadin/control-center \ # (1)
-n control-center --create-namespace \ # (2)
--set serviceAccount.clusterAdmin=true \ # (3)
-f values-ingress.yaml \ # (4)
--wait # (5)
----

<1> This installs Control Center.
<2> This creates a dedicated namespace to isolate Control Center from other applications.
<3> Grants administrative privileges that allow Control Center to manage cluster resources.
<4> Configures a custom ingress configuration (see below)
<5> This says for Helm to wait until Control Center is fully deployed.

Granting administrative privileges enables automatic installation of required dependencies. If you choose not to grant these privileges, though, you'll need to install necessary resources, manually.

This is an example of a custom ingress configuration:

[.example]
--
.values-ingress.yaml
[source,yaml,subs="+quotes,verbatim"]
----
ingress:
enabled: true
className: "nginx"
hosts:
- host: "control-center.example.com"
paths:
- path: "/"
pathType: Prefix
tls:
- hosts:
- "control-center.example.com"
secretName: "control-center-tls"
----
--


== Accessing Control Center

Expand Down

0 comments on commit 1032b27

Please sign in to comment.