From af706a22dc59bad211ed7900524e85465859bdf5 Mon Sep 17 00:00:00 2001 From: Matthew Wilson <98319962+MatthewVaadin@users.noreply.github.com> Date: Wed, 18 Dec 2024 10:26:36 +0200 Subject: [PATCH] Cleanup pages for Control Center 1.1 (#4002) --- .../getting-started/configure-installation.adoc | 10 +++++----- .../control-center/getting-started/docker-desktop.adoc | 2 +- articles/control-center/getting-started/index.adoc | 7 +++++-- .../getting-started/local-environment.adoc | 7 +++++-- 4 files changed, 16 insertions(+), 10 deletions(-) diff --git a/articles/control-center/getting-started/configure-installation.adoc b/articles/control-center/getting-started/configure-installation.adoc index 3797012d0a..95541cb8b9 100644 --- a/articles/control-center/getting-started/configure-installation.adoc +++ b/articles/control-center/getting-started/configure-installation.adoc @@ -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] @@ -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 `example@mydomain.com`. 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 `example@mydomain.com`. 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 diff --git a/articles/control-center/getting-started/docker-desktop.adoc b/articles/control-center/getting-started/docker-desktop.adoc index ea45a300a0..1d93b76adb 100644 --- a/articles/control-center/getting-started/docker-desktop.adoc +++ b/articles/control-center/getting-started/docker-desktop.adoc @@ -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 --- diff --git a/articles/control-center/getting-started/index.adoc b/articles/control-center/getting-started/index.adoc index 7bed11ec3d..2ca4ebac21 100644 --- a/articles/control-center/getting-started/index.adoc +++ b/articles/control-center/getting-started/index.adoc @@ -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 <> guide. == Prerequisites @@ -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 <> page for more details. + Here's an example of a custom ingress configuration: [.example] @@ -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 diff --git a/articles/control-center/getting-started/local-environment.adoc b/articles/control-center/getting-started/local-environment.adoc index 693e5a9e06..a972655cef 100644 --- a/articles/control-center/getting-started/local-environment.adoc +++ b/articles/control-center/getting-started/local-environment.adoc @@ -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 --- @@ -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 @@ -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 <> page for more details. + == Accessing Control Center