Skip to content

[Control Center] Add discussion IDs #4334

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

Open
wants to merge 1 commit into
base: latest
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,5 @@ Add the following line to that file:
----
127.0.0.1 app.local
----

[discussion-id]`B70B912D-5A08-4F13-9EEF-A618367F2C27`
2 changes: 2 additions & 0 deletions articles/control-center/application-deployment/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -188,3 +188,5 @@ Once selected, you can explore the following management options:
- *Localization*: Upload and manage translations for different languages, enabling a localized experience for your users.

Explore the Control Center's features to further customize and optimize your application in the cluster.

[discussion-id]`344CA437-7119-407C-B58A-946035D0B720`
2 changes: 2 additions & 0 deletions articles/control-center/dev-mode/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -160,3 +160,5 @@ Below is a list of additional resources you may find helpful:

- https://www.telepresence.io/docs/latest/quick-start[Telepresence Documentation]
- https://www.telepresence.io/docs/latest/howtos/intercepts[Understanding Intercepts in Telepresence]

[discussion-id]`198E794C-C0B7-4538-BA84-82CC07A7387D`
Original file line number Diff line number Diff line change
Expand Up @@ -112,3 +112,5 @@ By integrating these features, Control Center reduces administrative overhead an
====
For other DNS providers, refer to the https://github.com/kubernetes-sigs/external-dns/blob/master/docs/tutorials.md[ExternalDNS provider tutorials].
====

[discussion-id]`E328B835-7059-4EE1-AE4C-A6B4A4F5709E`
9 changes: 5 additions & 4 deletions articles/control-center/getting-started/azure.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Kubernetes on Azure
page-title: Installing Vaadin Control Center on Azure
description: Learn how to set up a Control Center on Kubernetes running on Azure.
meta-description: Vaadin Control Center simplifies the management of Vaadin applications on Kubernetes clusters.
meta-description: Vaadin Control Center simplifies the management of Vaadin applications on Kubernetes clusters.
order: 50
---

Expand Down Expand Up @@ -131,7 +131,7 @@ external-dns:
name: azure

txtOwnerId: "control-center"

domainFilters:
- *domain

Expand Down Expand Up @@ -170,11 +170,11 @@ helm install control-center oci://docker.io/vaadin/control-center \
--wait
----


=== Deploying without DNS zone (Not recommended)


* Deploy Vaadin Control Center
* Deploy Vaadin Control Center

[source, bash]
----
Expand All @@ -200,3 +200,4 @@ kubectl get secret control-center-user -n $NAME -o go-template="{{ .data.passwor

* Log in to Vaadin Control Center using the URL provided in the output of the previous command (the URL follows the `https://control.<your-domain>` format), along with the email address you provided during the installation and the temporary password you retrieved in the previous step.

[discussion-id]`88698F34-96CF-4733-9EA6-873EB5B2BC4A`
Original file line number Diff line number Diff line change
Expand Up @@ -198,3 +198,5 @@ pass:[<!-- vale Vale.Terms = YES -->]
}
</style>
++++

[discussion-id]`133614E2-638B-4268-BBEA-0A5856E3C551`
2 changes: 2 additions & 0 deletions articles/control-center/getting-started/docker-desktop.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,5 @@ To enable Kubernetes in Docker Desktop, follow these steps:
. Switch the slider next to "Enable Kubernetes" to the on position and click the "Apply & Restart" button.

image::images/docker.png[Docker Desktop]

[discussion-id]`72879B6B-CB2C-4923-A42F-3B715ACB26E0`
2 changes: 2 additions & 0 deletions articles/control-center/getting-started/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -145,3 +145,5 @@ image::images/dashboard-view.png[Control Center Dashboard]
At this point, the dashboard should notify you that no applications are available. This is because none are deployed yet.

To start deploying your Vaadin applications and take full advantage of Control Center's features, proceed to the <<../application-deployment#,Application Deployment>> documentation page.

[discussion-id]`FD7A1112-CB47-4D48-A2EA-DDAD29C5C053`
Original file line number Diff line number Diff line change
Expand Up @@ -166,3 +166,5 @@ It is important to xref:../getting-started/local-environment#windows[update] the
----

Note that there are other entries added to the `hosts` file which are also important. Those should be added automatically by the Docker Desktop when the Kubernetes and WSL engines are enabled.

[discussion-id]`11F549AD-89B9-4A90-8400-E5ED619A97EA`
2 changes: 2 additions & 0 deletions articles/control-center/getting-started/uninstall.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,5 @@ kubectl delete namespace installation-namespace
----

You'll have to replace `installation-namespace` with the namespace where Control Center was installed.

[discussion-id]`F81AC014-904E-4B95-B98E-C549760F5E1F`
2 changes: 2 additions & 0 deletions articles/control-center/getting-started/upgrade.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,5 @@ kubectl -n control-center set image deployment/control-center app=vaadin/control
----

Replace `version` with the version to which you want to upgrade. For example, to upgrade to version 1.1.0, you would use `1.1.0`.

[discussion-id]`0541FD78-6655-47C2-BE62-AECBB66CC2A9`
4 changes: 3 additions & 1 deletion articles/control-center/identity-management/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ Once the group is created, the assigned users inherit the permissions associated

An identity provider represents an external service, which can be used to authenticate access to Control Center, or a deployed application. This can be a social provider or a custom provider. The supported social providers are GitHub, Google, LinkedIn, Microsoft, and X (formerly Twitter). A custom provider can be any that implements the OpenID Connect 1.0 protocol (e.g., Okta).

When creating an identity provider, you need to choose the type of the provider you want to create from the list presented. Afterwards, in the case of social providers, you need to specify the `Alias`, `Display Name`, `Client ID`, and `Client Secret`. If you've already registered a client with an external identity provider, you only need to provide its ID and secret. If not, you can follow the link under the provider list, which takes you to the provider's page where you can create a new client.
When creating an identity provider, you need to choose the type of the provider you want to create from the list presented. Afterwards, in the case of social providers, you need to specify the `Alias`, `Display Name`, `Client ID`, and `Client Secret`. If you've already registered a client with an external identity provider, you only need to provide its ID and secret. If not, you can follow the link under the provider list, which takes you to the provider's page where you can create a new client.

When everything is filled in, you can copy the `Login Redirect URI` or the `Logout Redirect URI`, and use them in your external provider's client to tell it where to redirect the user after a successful authentication or logout, respectively. At the end, click on the [guibutton]*Create* button. As an example, creating a Google identity provider looks like this:

Expand Down Expand Up @@ -189,3 +189,5 @@ After the user has completed this authentication process, Control Center permits
== Login & Logout Controls

To create login and logout links or buttons in your Vaadin application, refer to the guide on <<login-logout#,Creating Login and Logout Controls>>.

[discussion-id]`74FB605D-F5C5-4B36-A22A-41E358F51441`
8 changes: 5 additions & 3 deletions articles/control-center/identity-management/login-logout.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ For users to login and logout, it's useful to provide them with a link or button

== Adding Login

To add a login link or button to a Vaadin application, you'll need to create a component that redirects users to the login page provided by Control Center -- for when they click on the link or button.
To add a login link or button to a Vaadin application, you'll need to create a component that redirects users to the login page provided by Control Center -- for when they click on the link or button.

Here's an example of how you might do that:

Expand All @@ -38,14 +38,14 @@ public class MainLayout extends AppLayout {
----

<1> This part creates a login button.
<2> This creates a login link.
<2> This creates a login link.

You probably wouldn't want both a button and a link. You'll have to decide which you want, and disregard the other in this example.


== Adding Logout

To add a logout link or button to a Vaadin application, you'll need to create a component that triggers the logout process.
To add a logout link or button to a Vaadin application, you'll need to create a component that triggers the logout process.

Here's an example of how to create only a button:

Expand Down Expand Up @@ -90,3 +90,5 @@ public class MainLayout extends AppLayout {
== Deploy the Application

To deploy the application, see <<../application-deployment#,Deploying a Vaadin Application with Control Center>>. Be sure to activate the Identity Management feature.

[discussion-id]`EDA02A5B-AEF3-4219-8A80-3F334CE14CE7`
2 changes: 2 additions & 0 deletions articles/control-center/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -65,3 +65,5 @@ Control Center offers a comprehensive solution for managing your Vaadin applicat
== Discover Control Center

section_outline::[]

[discussion-id]`F27EC68A-DCAE-4173-B019-25B8AD5A97C3`
2 changes: 2 additions & 0 deletions articles/control-center/localization/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -107,3 +107,5 @@ After changing a translation in Control Center, the browser tab with the preview
To get updated translations back into the application's source code, they can be downloaded from the [guilabel]*Translations* view. Open the drop-down in the top right corner and select the [guibutton]*Download translations* item to trigger a download of a [filename]`.zip` file. That file contains [filename]`.properties` files for each language that was present in the translation upload, now containing translations that have been added or updated in Control Center.

You can then copy the [filename]`.properties` files back into your application's `translations` resource bundle, which is usually in [filename]`src/main/resources/vaadin-i18n`.

[discussion-id]`8124CFA4-F694-4A96-8A81-1ADF4F36F5DB`
2 changes: 2 additions & 0 deletions articles/control-center/security/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,5 @@ An actuator endpoint is a public HTTP endpoint that provides information about t
When the <<../identity-management#,Identity Management>> feature is enabled, the application is configured to use Keycloak for authentication and authorization. The users, groups, and roles are managed by Control Center, which is backed by a Keycloak instance. This requires the Keycloak instance to be accessible outside the cluster, which introduces a potential for disruption if it's compromised.

Control Center creates a Keycloak administrator user during installation. This user account has the ability to access the Keycloak instance directly, but you shouldn't use it normally. The username and password (base 64 encoded) are stored in the secret named `<installation-name>-keycloak-initial-admin`, where `<installation-name>` is the Control Center name chosen during installation. It's important to keep this user's credentials secure, as they provide full access to the Keycloak instance, and manual changes may cause disruption to Control Center features.

[discussion-id]`CA2EAA4C-5113-4E3E-8D9C-4A649D262D09`
4 changes: 3 additions & 1 deletion articles/control-center/troubleshooting/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ This example modifies the Control Center deployment with a CPU request of 2 CPU
== DNS Record Propagation Delays

DNS propagation refers to the process of updating information on the internet's DNS (Domain Name System) servers.
DNS servers are responsible for the mapping of domain names to IP addresses.
DNS servers are responsible for the mapping of domain names to IP addresses.
In essence, DNS propagation is the time required for DNS servers worldwide to update their cached information for a domain name.

DNS propagation can take some time to complete because it involves updating information on many servers across the internet.
Expand Down Expand Up @@ -158,3 +158,5 @@ image::images/docker_image_not_found.png[Docker image not found]

If the image is hosted in a private repository, you might need to provide an image pull secret as necessary authentication to pull the image.
This value can be provided in the application deploy screen, below the field where the docker image is provided.

[discussion-id]`DD5CC002-0FD2-451A-8CA2-5FD8C18E37FC`
Loading