Enable SSO for Kubernetes deployment

1. Create a hub.values.yaml file and add there the configuration of your volumes. Refer to the examples below.

   volumeClaimTemplates: - metadata: name: hub spec: accessModes: - ReadWriteOnce resources: requests: storage: 10Gi volumeMounts: - name: hub mountPath: /opt/hub/data subPath: data - name: hub mountPath: /opt/hub/conf subPath: conf - name: hub mountPath: /opt/hub/logs subPath: logs - name: hub mountPath: /opt/hub/backups subPath: backups ingress: enabled: true hosts: - host: hub.example.com paths: - path: / pathType: Prefix annotations: kubernetes.io/ingress.class: "nginx"

2. Install the Hub Helm chart and wait, until Hub's pod is in Ready state.

   helm install -f hub.values.yaml hub datalore/hub --version 0.2.26
   kubectl wait --for=condition=Ready pod/hub-0

3. Check the pod logs (using the kubectl logs service/hub command) for a wizard_token. The output should have a line like this:

   JetBrains Hub 2024.3 Configuration Wizard will listen inside container on {0.0.0.0:8080}/ after start and can be accessed by this URL: [http://<put-your-docker-HOST-name-here>:<put-host-port-mapped-to-container-port-8080-here>/?wizard_token=pPXTShp4NXceXqGYzeAq].

   Copy the wizard_token value to the clipboard - this value is required during the Hub bootstrapping procedure.

4. Open the Hub's base URL in your browser and insert the wizard_token into the Token field.

5. Click the Log in button.

6. Click the Set Up link.

7. Generate a URL (referred to as HUB_ROOT_URL later) to access Hub by the Datalore. Consider the following:

   • The URL must be accessible from both the Datalore pod and the browser (by the end users of your Datalore installation).

   • The URL must point to the / path of your Hub installation, i.e. http://127.0.0.1:8080/ inside the container where Hub is launched (by default, the hub-0 pod).

   • How you set up your cluster to serve such a URL depends on the specifics of your cluster configuration.

8. In Base URL, enter HUB_ROOT_URL. Do not change the Application Listen Port setting.

9. Click the Next button.

10. Configure the admin account by setting the admin password.

11. Click the Next button.

12. Click the Finish button and wait for Hub to start.

Configure the Datalore service

1. Generate one more URL (referred to as DATALORE_ROOT_URL later) to access Datalore. Consider the following:

   • The URL must be accessible from the browser (by the end users of your Datalore installation).

   • The URL must point to the / path of your Datalore installation, i.e. http://127.0.0.1:8080/ inside the container where Datalore will be launched (by default, it is pod datalore-0).

   • How you set up your cluster to serve such a URL depends on the specifics of your cluster configuration.

2. Go to Services (${HUB_ROOT_URL}/hub/services) and click the New service button. Use the name datalore and enter DATALORE_ROOT_URL in Home URL.

3. Copy the ID field value and save it somewhere: it is used when configuring Datalore ($HUB_DATALORE_SERVICE_ID property).

4. Click the Change... button next to the Secret label.

5. Copy the generated secret and save it somewhere: it will be used when configuring Datalore ($HUB_DATALORE_SERVICE_SECRET property).

6. Click the Change secret button.

7. Enter DATALORE_ROOT_URL in the Base URLs field.

8. Enter the line /api/hub/openid/login in the Redirect URIs field.

9. Click the Trust Service button in the upper right corner.

10. Click the Save button.

Create a Hub token

1. Go to Users (${HUB_ROOT_URL}/hub/users).

2. Click your admin username.

3. Switch to the Account Security tab.

4. Click the New token... button.

5. Add Hub and Datalore into Scope. You can use any Name. Click the Create button. Copy the token (with the perm: prefix) and save it somewhere. It will be used when configuring Datalore ($HUB_PERM_TOKEN property).

(Optional) Force email verification

Datalore uses user emails from Hub; so it is recommended to force email verification in Hub. When this option is enabled, users with unverified emails will not be able to use Datalore.

1. Configure the SMTP server:

   • Go to SMTP (${HUB_ROOT_URL}/hub/smtp-settings).

   • Click the Configure SMTP server... button.

   • Configure your SMTP server parameters.

   • Click the Save button.

   • Click the Enable notifications button.

   • (Optional) To make sure your configuration is working, click the Send Test message button.

2. Enable email verification:

   • Go to Auth Modules (${HUB_ROOT_URL}/hub/authmodules).

   • Open the Common settings page.

   • Enable the Email verification option.

   • Click the Save button.

3. Set and verify an admin user email:

   • Go to Users (${HUB_ROOT_URL}/hub/users).

   • Click your admin username.

   • Set an email in the Email field.

   • Click the Save button.

   • Click the Send verification email link.

   • Find the verification email in your inbox and click the Verify email address button.

(Optional) Enable auth modules

1. Go to Auth Modules (${HUB_ROOT_URL}/hub/authmodules).

2. Add or remove auth modules (for example, Google Auth, GitHub Auth, LDAP, and so on). Find more details here.