Skip to content

Commit

Permalink
Cleanup pages for Control Center 1.1 (#4002)
Browse files Browse the repository at this point in the history
  • Loading branch information
MatthewVaadin authored Dec 18, 2024
1 parent 16ece55 commit af706a2
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,7 @@ order: 30

This page explains how to configure the installation of Control Center using Helm. Many parameters can be set, including your domain and user information.

Below is an example using the Helm command to configure several items. You would change all of the values in the example to your particular use.

In the first line shown, the name of the installed application is set to `control-center-name`. The second line gives the namespace in which the application is installed is set to `foo-namespace`. In the third line, the value of `domain`, which is required, is set to `mydomain.com`.
Below is an example using the Helm command to configure several items. You would change the values in the example to your particular use.

.Terminal
[source,bash]
Expand All @@ -25,9 +23,11 @@ helm install control-center-name oci://docker.io/vaadin/control-center \
--wait
----

In this example above, the required value of `user.email` is set to `[email protected]`. The optional value of `app.host` is set to `cc.mydomain.com`. And in the second to last line, the values for the Ingress are set using a file named `values-ingress.yaml`.
In the first line of the example above, the name of the installed application is set to `control-center-name`. The second line gives the namespace in which the application is installed, which is set to `foo-namespace`. In the third line, the value of `domain`, which is required, is set to `mydomain.com`.

The required value of `user.email` is set to `[email protected]`. The optional value of `app.host` is set to `cc.mydomain.com`. And in the second to last line, the values for the Ingress are set using a file named `values-ingress.yaml`.

More command options are available than the ones shown in the example above, for configuring the installation. All of them are explained in detail in the https://helm.sh/docs/helm/helm_install/[Helm documentation].
More command options, than the ones shown in the example above, are available for configuring the installation. All of them are explained in detail in the https://helm.sh/docs/helm/helm_install/[Helm documentation].


== Values
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Kubernetes on Docker Desktop
description: Learn how to set up a Kubernetes cluster on Docker Desktop.
order: 15
order: 50
---


Expand Down
7 changes: 5 additions & 2 deletions articles/control-center/getting-started/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ order: 10
Control Center simplifies the management of Vaadin applications on Kubernetes clusters. This page explains how to deploy Control Center to a cloud environment and get it running smoothly.

[NOTE]
Control Center is designed to run in a production environment. For local development, see the <<../getting-started/local-environment#,Getting Started in a Local Environment>> guide.
Control Center is designed to run in a production environment. For local development, see the <<local-environment#,Getting Started in a Local Environment>> guide.


== Prerequisites
Expand Down Expand Up @@ -46,6 +46,9 @@ helm install control-center oci://docker.io/vaadin/control-center \

You'd replace `mydomain.com` here with your domain, and replace the email address with your own. The email address is used to create the initial user account in Control Center.

[NOTE]
The installation of Control Center can be customized by modifying the Helm command. See the <<configure-installation#,Configure Installation>> page for more details.

Here's an example of a custom ingress configuration:

[.example]
Expand Down Expand Up @@ -102,7 +105,7 @@ Once deployed, copy the temporary password for the initial user. Execute the fol
kubectl -n control-center get secret control-center-user -o go-template="{{ .data.password | base64decode | println }}"
----

You can access Control Center through the web browser at `http://control.mydomain.com` -- replacing "mydomain.com" with your domain.
You can access Control Center through the web browser at `\http://control.mydomain.com` -- replacing "mydomain.com" with your domain.


=== Logging In
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Getting Started in a Local Environment
description: How to set up Control Center in a local environment.
order: 40
order: 20
---


Expand All @@ -22,7 +22,7 @@ You'll also need to install https://helm.sh/[Helm]. It's a Kubernetes package ma

== Configure Hosts File

To access Control Center from your local machine, you'll need to add a couple of entries to your [filename]`hosts` file. Where you'll find this file will depend on the operating system you're using.
To access Control Center from your local machine, you'll need to add a couple of entries to your [filename]`hosts` file. Where you'll find this file will depend on the operating system you're using.


=== Linux & macOS
Expand Down Expand Up @@ -73,6 +73,9 @@ helm install control-center oci://docker.io/vaadin/control-center \

Replace the email address with your own. This is used to create the initial user account in Control Center.

[NOTE]
The installation of Control Center can be customized by modifying the Helm command. See the <<configure-installation#,Configure Installation>> page for more details.


== Accessing Control Center

Expand Down

0 comments on commit af706a2

Please sign in to comment.