diff --git a/README.md b/README.md index 5c452ec8..e34682c1 100644 --- a/README.md +++ b/README.md @@ -100,9 +100,9 @@ helm repo update ```bash helm install theia-cloud-base theia-cloud-remote/theia-cloud-base --set issuer.email=your-mail@example.com -helm install theia-cloud-crds theia-cloud-remote/theia-cloud-crds --namespace theiacloud --create-namespace +helm install theia-cloud-crds theia-cloud-remote/theia-cloud-crds --namespace theia-cloud --create-namespace -helm install theia-cloud theia-cloud-remote/theia-cloud --namespace theiacloud +helm install theia-cloud theia-cloud-remote/theia-cloud --namespace theia-cloud ``` ### Install the current next version @@ -112,21 +112,21 @@ Simply add the `--devel` flag: ```bash helm install theia-cloud-base theia-cloud-remote/theia-cloud-base --set issuer.email=your-mail@example.com --devel -helm install theia-cloud-crds theia-cloud-remote/theia-cloud-crds --namespace theiacloud --create-namespace --devel +helm install theia-cloud-crds theia-cloud-remote/theia-cloud-crds --namespace theia-cloud --create-namespace --devel -helm install theia-cloud theia-cloud-remote/theia-cloud --namespace theiacloud --devel +helm install theia-cloud theia-cloud-remote/theia-cloud --namespace theia-cloud --devel ``` ### Optional: switch to the newly created namespace ```bash -kubectl config set-context --current --namespace=theiacloud +kubectl config set-context --current --namespace=theia-cloud ``` ### Uninstall ```bash -helm uninstall theia-cloud -n theiacloud +helm uninstall theia-cloud -n theia-cloud ``` ### Getting started with diff --git a/demo/dockerfiles/demo-theia-monitor-vscode/Dockerfile b/demo/dockerfiles/demo-theia-monitor-vscode/Dockerfile index e30ca90a..2b4fd889 100644 --- a/demo/dockerfiles/demo-theia-monitor-vscode/Dockerfile +++ b/demo/dockerfiles/demo-theia-monitor-vscode/Dockerfile @@ -2,8 +2,8 @@ FROM node:18-bullseye-slim as build-stage # Copy and unzip the vsix file RUN apt-get update && apt-get install -y unzip && rm -rf /var/lib/apt/lists/* -COPY theiacloud-monitor-0.12.0-next.vsix /tmp/theiacloud-monitor.vsix -RUN mkdir /tmp/extracted && unzip /tmp/theiacloud-monitor.vsix -d /tmp/extracted +COPY theia-cloud-monitor-0.12.0-next.vsix /tmp/theia-cloud-monitor.vsix +RUN mkdir /tmp/extracted && unzip /tmp/theia-cloud-monitor.vsix -d /tmp/extracted FROM theiacloud/theia-cloud-demo:0.12.0-next as production-stage diff --git a/demo/dockerfiles/demo-theia-monitor-vscode/theiacloud-monitor-0.12.0-next.vsix b/demo/dockerfiles/demo-theia-monitor-vscode/theia-cloud-monitor-0.12.0-next.vsix similarity index 93% rename from demo/dockerfiles/demo-theia-monitor-vscode/theiacloud-monitor-0.12.0-next.vsix rename to demo/dockerfiles/demo-theia-monitor-vscode/theia-cloud-monitor-0.12.0-next.vsix index 579df495..03af94b1 100644 Binary files a/demo/dockerfiles/demo-theia-monitor-vscode/theiacloud-monitor-0.12.0-next.vsix and b/demo/dockerfiles/demo-theia-monitor-vscode/theia-cloud-monitor-0.12.0-next.vsix differ diff --git a/documentation/Architecture.md b/documentation/Architecture.md index 12eb5926..04ea6298 100644 --- a/documentation/Architecture.md +++ b/documentation/Architecture.md @@ -2,7 +2,7 @@ The Theia Cloud Operator listens for changes to custom resources inside the cluster. With those custom resources clients may trigger the creation/deletion/handling of workspaces and sessions. The Operator is responsible for handling all things that are related to the Kubernetes-Resources for workspaces and sessions. All access is authenticated via an Authenticator. -![Theia Cloud Diagram](theiacloud.png "Theia Cloud") +![Theia Cloud Diagram](theia-cloud.png "Theia Cloud") ## Operator Java Overview diff --git a/documentation/Install.md b/documentation/Install.md index 82047ea0..0bf9a8ab 100644 --- a/documentation/Install.md +++ b/documentation/Install.md @@ -76,9 +76,9 @@ helm repo update ```bash helm install theia-cloud-base theia-cloud-remote/theia-cloud-base --set issuer.email=your-mail@example.com -helm install theia-cloud-crds theia-cloud-remote/theia-cloud-crds --namespace theiacloud --create-namespace +helm install theia-cloud-crds theia-cloud-remote/theia-cloud-crds --namespace theia-cloud --create-namespace -helm install theia-cloud theia-cloud-remote/theia-cloud --namespace theiacloud +helm install theia-cloud theia-cloud-remote/theia-cloud --namespace theia-cloud ``` ### Install the current next version @@ -88,31 +88,31 @@ Simply add the `--devel` flag: ```bash helm install theia-cloud-base theia-cloud-remote/theia-cloud-base --set issuer.email=your-mail@example.com --devel -helm install theia-cloud-crds theia-cloud-remote/theia-cloud-crds --namespace theiacloud --create-namespace --devel +helm install theia-cloud-crds theia-cloud-remote/theia-cloud-crds --namespace theia-cloud --create-namespace --devel -helm install theia-cloud theia-cloud-remote/theia-cloud --namespace theiacloud --devel +helm install theia-cloud theia-cloud-remote/theia-cloud --namespace theia-cloud --devel ``` ### Optional: switch to the newly created namespace ```bash -kubectl config set-context --current --namespace=theiacloud +kubectl config set-context --current --namespace=theia-cloud ``` ### Trouble shooting Recreate tls secret for sessions: -`kubectl delete secret ws-cert-secret -n theiacloud` +`kubectl delete secret ws-cert-secret -n theia-cloud` ## Check ```bash -helm get manifest theia-cloud -n theiacloud +helm get manifest theia-cloud -n theia-cloud ``` ## Uninstall ```bash -helm uninstall theia-cloud -n theiacloud +helm uninstall theia-cloud -n theia-cloud ``` diff --git a/documentation/Naming.md b/documentation/Naming.md new file mode 100644 index 00000000..e56c25ae --- /dev/null +++ b/documentation/Naming.md @@ -0,0 +1,32 @@ +# Naming Conventions + +The project is called "Theia Cloud" (with a space) and is a subproject of Eclipse Theia. + +As different languages and use cases use other conventions for naming, we try to follow these conventions as close as possible. + +Please see below guidelines for know usages of specific style conventions. + +## theia.cloud + +In general, use `theia.cloud` in hierachies and for identifiers, e.g. + +- Java package/jar names, e.g. `org.eclipse.theia.cloud` +- Java (system) properties , e.g. `-Dtheia.cloud.app.id=asdfghjkl` +- Group Names / Metadata Names in Kubernetes Custom Resource Definitions, e.g. `theia.cloud`, `theia.cloud/v1beta9`, `sessions.theia.cloud` +- Theia Command identifiers, e.g. `theia.cloud.monitor.activity.report` + +## TheiaCloud / theiaCloud + +Use Pascal Case / Camel Case in Java/Typescript class/method/property names, e.g. `DefaultTheiaCloudOperatorLauncher` or `window.theiaCloudConfig`. + +Other uses are places where you usually may use any cases, but want to avoid spaces (for technical reasons), e.g. the KeyCloak Realm `TheiaCloud`. + +## theia-cloud + +## THEIA_CLOUD + +## Theia Cloud + +## theia-cloud.io + +To follow conventions for labels in Kubernetes, we use our regular domain as a prefix for custom labels, e.g. `theia-cloud.io/workspace.name` diff --git a/documentation/operator.graphml b/documentation/operator.graphml index 51eb645d..c3c656e5 100644 --- a/documentation/operator.graphml +++ b/documentation/operator.graphml @@ -21,7 +21,7 @@ - TheiaCloud + Theia Cloud @@ -67,7 +67,7 @@ AppDefinitionAddedHandler - <<interface>> + <<interface>> SessionAddedHandler @@ -98,7 +98,7 @@ SessionAddedHandler - LazyStartSessionAddedHandler + LazyStartSessionAddedHandler @@ -113,7 +113,7 @@ SessionAddedHandler - EagerStartSessionAddedHandler + EagerStartSessionAddedHandler @@ -143,7 +143,7 @@ SessionAddedHandler - We may have different kinds of implementations of the handlers. + We may have different kinds of implementations of the handlers. E.g. we might have handlers that start up unassigned pods already and assign the running pods to a user on session added (EagerStart) Or we could do it Che-like and spin up the pod when a new session is added @@ -174,7 +174,7 @@ IngressCreationService - Listens for app definition/sessions changes + Listens for app definition/sessions changes and delegates to handlers diff --git a/documentation/theiacloud.png b/documentation/theia-cloud.png similarity index 100% rename from documentation/theiacloud.png rename to documentation/theia-cloud.png diff --git a/java/operator/README.md b/java/operator/README.md index 720999b8..f9849178 100644 --- a/java/operator/README.md +++ b/java/operator/README.md @@ -36,7 +36,7 @@ To debug the Default Theia Cloud Operator, follow these steps: minikube ip ``` -_Note_: Ensure your local `kubectl` is set to the correct namespace (e.g., `theiacloud`), as the debuggable operator will interact with your local Kubernetes cluster. +_Note_: Ensure your local `kubectl` is set to the correct namespace (e.g., `theia-cloud`), as the debuggable operator will interact with your local Kubernetes cluster. ### Theia Cloud Operator Library diff --git a/java/operator/org.eclipse.theia.cloud.operator/src/main/java/org/eclipse/theia/cloud/operator/handler/appdef/EagerStartAppDefinitionAddedHandler.java b/java/operator/org.eclipse.theia.cloud.operator/src/main/java/org/eclipse/theia/cloud/operator/handler/appdef/EagerStartAppDefinitionAddedHandler.java index c0e7efef..fed9a707 100644 --- a/java/operator/org.eclipse.theia.cloud.operator/src/main/java/org/eclipse/theia/cloud/operator/handler/appdef/EagerStartAppDefinitionAddedHandler.java +++ b/java/operator/org.eclipse.theia.cloud.operator/src/main/java/org/eclipse/theia/cloud/operator/handler/appdef/EagerStartAppDefinitionAddedHandler.java @@ -57,7 +57,7 @@ public class EagerStartAppDefinitionAddedHandler implements AppDefinitionHandler private static final Logger LOGGER = LogManager.getLogger(EagerStartAppDefinitionAddedHandler.class); - public static final String LABEL_KEY = "theiacloud"; + public static final String LABEL_KEY = "theia-cloud.io/template-purpose"; public static final String LABEL_VALUE_PROXY = "proxy"; public static final String LABEL_VALUE_EMAILS = "emails"; diff --git a/java/operator/org.eclipse.theia.cloud.operator/src/main/resources/templateConfigmap.yaml b/java/operator/org.eclipse.theia.cloud.operator/src/main/resources/templateConfigmap.yaml index 8070abba..4936c928 100644 --- a/java/operator/org.eclipse.theia.cloud.operator/src/main/resources/templateConfigmap.yaml +++ b/java/operator/org.eclipse.theia.cloud.operator/src/main/resources/templateConfigmap.yaml @@ -3,7 +3,7 @@ kind: ConfigMap metadata: name: placeholder-configname labels: - theiacloud: proxy + theia-cloud.io/template-purpose: proxy namespace: placeholder-namespace ownerReferences: - apiVersion: theia.cloud/v1beta9 diff --git a/java/operator/org.eclipse.theia.cloud.operator/src/main/resources/templateConfigmapEmails.yaml b/java/operator/org.eclipse.theia.cloud.operator/src/main/resources/templateConfigmapEmails.yaml index 595dfd76..2d2e27de 100644 --- a/java/operator/org.eclipse.theia.cloud.operator/src/main/resources/templateConfigmapEmails.yaml +++ b/java/operator/org.eclipse.theia.cloud.operator/src/main/resources/templateConfigmapEmails.yaml @@ -3,7 +3,7 @@ kind: ConfigMap metadata: name: placeholder-emailsconfigname labels: - theiacloud: emails + theia-cloud.io/template-purpose: emails namespace: placeholder-namespace ownerReferences: - apiVersion: theia.cloud/v1beta9 diff --git a/java/operator/org.eclipse.theia.cloud.operator/src/main/resources/templateDeployment.yaml b/java/operator/org.eclipse.theia.cloud.operator/src/main/resources/templateDeployment.yaml index 10f139af..6e403ad9 100644 --- a/java/operator/org.eclipse.theia.cloud.operator/src/main/resources/templateDeployment.yaml +++ b/java/operator/org.eclipse.theia.cloud.operator/src/main/resources/templateDeployment.yaml @@ -55,29 +55,29 @@ spec: cpu: placeholder-cpu-requests memory: placeholder-memory-requests env: - - name: THEIACLOUD_APP_ID + - name: THEIA_CLOUD_APP_ID value: placeholder-env-app-id - - name: THEIACLOUD_SERVICE_URL + - name: THEIA_CLOUD_SERVICE_URL value: placeholder-env-service-url - - name: THEIACLOUD_SESSION_UID + - name: THEIA_CLOUD_SESSION_UID value: placeholder-env-session-uid - - name: THEIACLOUD_SESSION_NAME + - name: THEIA_CLOUD_SESSION_NAME value: placeholder-env-session-name - - name: THEIACLOUD_SESSION_USER + - name: THEIA_CLOUD_SESSION_USER value: placeholder-env-session-user - - name: THEIACLOUD_SESSION_URL + - name: THEIA_CLOUD_SESSION_URL value: placeholder-env-session-url - - name: THEIACLOUD_SESSION_SECRET + - name: THEIA_CLOUD_SESSION_SECRET value: placeholder-env-session-secret - - name: THEIACLOUD_MONITOR_ENABLE_ACTIVITY_TRACKER + - name: THEIA_CLOUD_MONITOR_ENABLE_ACTIVITY_TRACKER value: placeholder-enable-activity-tracker - - name: THEIACLOUD_MONITOR_PORT + - name: THEIA_CLOUD_MONITOR_PORT value: placeholder-monitor-env-port - - name: THEIACLOUD_KEYCLOAK_URL + - name: THEIA_CLOUD_KEYCLOAK_URL value: placeholder-keycloak-env-url - - name: THEIACLOUD_KEYCLOAK_REALM + - name: THEIA_CLOUD_KEYCLOAK_REALM value: placeholder-keycloak-env-realm - - name: THEIACLOUD_KEYCLOAK_CLIENT_ID + - name: THEIA_CLOUD_KEYCLOAK_CLIENT_ID value: placeholder-keycloak-env-clientid securityContext: runAsUser: placeholder-uid diff --git a/java/operator/org.eclipse.theia.cloud.operator/src/main/resources/templateDeploymentWithoutOAuthProxy.yaml b/java/operator/org.eclipse.theia.cloud.operator/src/main/resources/templateDeploymentWithoutOAuthProxy.yaml index 0d17697a..6af75529 100644 --- a/java/operator/org.eclipse.theia.cloud.operator/src/main/resources/templateDeploymentWithoutOAuthProxy.yaml +++ b/java/operator/org.eclipse.theia.cloud.operator/src/main/resources/templateDeploymentWithoutOAuthProxy.yaml @@ -42,29 +42,29 @@ spec: cpu: placeholder-cpu-requests memory: placeholder-memory-requests env: - - name: THEIACLOUD_APP_ID + - name: THEIA_CLOUD_APP_ID value: placeholder-env-app-id - - name: THEIACLOUD_SERVICE_URL + - name: THEIA_CLOUD_SERVICE_URL value: placeholder-env-service-url - - name: THEIACLOUD_SESSION_UID + - name: THEIA_CLOUD_SESSION_UID value: placeholder-env-session-uid - - name: THEIACLOUD_SESSION_NAME + - name: THEIA_CLOUD_SESSION_NAME value: placeholder-env-session-name - - name: THEIACLOUD_SESSION_USER + - name: THEIA_CLOUD_SESSION_USER value: placeholder-env-session-user - - name: THEIACLOUD_SESSION_URL + - name: THEIA_CLOUD_SESSION_URL value: placeholder-env-session-url - - name: THEIACLOUD_SESSION_SECRET + - name: THEIA_CLOUD_SESSION_SECRET value: placeholder-env-session-secret - - name: THEIACLOUD_MONITOR_ENABLE_ACTIVITY_TRACKER + - name: THEIA_CLOUD_MONITOR_ENABLE_ACTIVITY_TRACKER value: placeholder-enable-activity-tracker - - name: THEIACLOUD_MONITOR_PORT + - name: THEIA_CLOUD_MONITOR_PORT value: placeholder-monitor-env-port - - name: THEIACLOUD_KEYCLOAK_URL + - name: THEIA_CLOUD_KEYCLOAK_URL value: placeholder-keycloak-env-url - - name: THEIACLOUD_KEYCLOAK_REALM + - name: THEIA_CLOUD_KEYCLOAK_REALM value: placeholder-keycloak-env-realm - - name: THEIACLOUD_KEYCLOAK_CLIENT_ID + - name: THEIA_CLOUD_KEYCLOAK_CLIENT_ID value: placeholder-keycloak-env-clientid securityContext: runAsUser: placeholder-uid diff --git a/java/operator/org.eclipse.theia.cloud.operator/src/main/resources/templatePersistentVolumeClaim.yaml b/java/operator/org.eclipse.theia.cloud.operator/src/main/resources/templatePersistentVolumeClaim.yaml index 94813cb0..1ee81739 100644 --- a/java/operator/org.eclipse.theia.cloud.operator/src/main/resources/templatePersistentVolumeClaim.yaml +++ b/java/operator/org.eclipse.theia.cloud.operator/src/main/resources/templatePersistentVolumeClaim.yaml @@ -4,7 +4,7 @@ metadata: name: placeholder-pv namespace: placeholder-namespace labels: - theia.cloud.workspace.name: placeholder-label-workspace-name + theia-cloud.io/workspace.name: placeholder-label-workspace-name spec: accessModes: - ReadWriteOnce diff --git a/java/operator/org.eclipse.theia.cloud.operator/src/main/resources/templatePersistentVolumeClaimMinikube.yaml b/java/operator/org.eclipse.theia.cloud.operator/src/main/resources/templatePersistentVolumeClaimMinikube.yaml index 16afbf95..00127761 100644 --- a/java/operator/org.eclipse.theia.cloud.operator/src/main/resources/templatePersistentVolumeClaimMinikube.yaml +++ b/java/operator/org.eclipse.theia.cloud.operator/src/main/resources/templatePersistentVolumeClaimMinikube.yaml @@ -4,7 +4,7 @@ metadata: name: placeholder-pv namespace: placeholder-namespace labels: - theia.cloud.workspace.name: placeholder-label-workspace-name + theia-cloud.io/workspace.name: placeholder-label-workspace-name spec: accessModes: - ReadWriteOnce diff --git a/java/service/org.eclipse.theia.cloud.service/README.md b/java/service/org.eclipse.theia.cloud.service/README.md index 3eaf710b..985ac1a6 100644 --- a/java/service/org.eclipse.theia.cloud.service/README.md +++ b/java/service/org.eclipse.theia.cloud.service/README.md @@ -74,8 +74,6 @@ Easily start your RESTful Web Services Unit tests use the Quarkus test infrastructure. -All tests can be run in Eclipse via launch config [TheiaCloud Service Tests](./TheiaCloud Service Tests.launch). - When running tests from an IDE, the following VM argument might need to be set to enable logging during tests (this is pre-configured in the launch config): ```bash diff --git a/java/service/org.eclipse.theia.cloud.service/src/main/java/org/eclipse/theia/cloud/service/K8sUtil.java b/java/service/org.eclipse.theia.cloud.service/src/main/java/org/eclipse/theia/cloud/service/K8sUtil.java index 99736966..8f99f973 100644 --- a/java/service/org.eclipse.theia.cloud.service/src/main/java/org/eclipse/theia/cloud/service/K8sUtil.java +++ b/java/service/org.eclipse.theia.cloud.service/src/main/java/org/eclipse/theia/cloud/service/K8sUtil.java @@ -187,7 +187,7 @@ private boolean isPodFromSession(Pod pod, Session session) { } Container container = optionalContainer.get(); Optional optionalEnv = container.getEnv().stream() - .filter(env -> env.getName().equals("THEIACLOUD_SESSION_NAME")).findFirst(); + .filter(env -> env.getName().equals("THEIA_CLOUD_SESSION_NAME")).findFirst(); if (optionalEnv.isEmpty()) { return false; } diff --git a/node/monitor-theia/src/common/env-variables.ts b/node/monitor-theia/src/common/env-variables.ts index e6692564..40abb5cd 100644 --- a/node/monitor-theia/src/common/env-variables.ts +++ b/node/monitor-theia/src/common/env-variables.ts @@ -1,6 +1,6 @@ /** * List of environment variables that the extension uses */ -export const MONITOR_ENABLE_ACTIVITY_TRACKER = 'THEIACLOUD_MONITOR_ENABLE_ACTIVITY_TRACKER'; +export const MONITOR_ENABLE_ACTIVITY_TRACKER = 'THEIA_CLOUD_MONITOR_ENABLE_ACTIVITY_TRACKER'; -export const THEIACLOUD_SESSION_SECRET = 'THEIACLOUD_SESSION_SECRET'; +export const THEIA_CLOUD_SESSION_SECRET = 'THEIA_CLOUD_SESSION_SECRET'; diff --git a/node/monitor-theia/src/common/monitor-protocol.ts b/node/monitor-theia/src/common/monitor-protocol.ts index ca57ffb5..1fd47fe2 100644 --- a/node/monitor-theia/src/common/monitor-protocol.ts +++ b/node/monitor-theia/src/common/monitor-protocol.ts @@ -1,8 +1,8 @@ import { MonitorBackendModule } from './monitor-backend-module'; -export const MONITOR_BACKEND_SERVICE_PATH = '/services/theiacloud-monitor'; -export const MESSAGING_SERVICE_PATH = '/services/theiacloud-monitor/messaging'; -export const ACTIVITY_TRACKER_SERVICE_PATH = '/services/theiacloud-monitor/activity-tracker'; +export const MONITOR_BACKEND_SERVICE_PATH = '/services/theia-cloud-monitor'; +export const MESSAGING_SERVICE_PATH = '/services/theia-cloud-monitor/messaging'; +export const ACTIVITY_TRACKER_SERVICE_PATH = '/services/theia-cloud-monitor/activity-tracker'; export const COMMAND_ACTIVITY_REPORT_TITLE = 'theia.cloud.monitor.activity.report'; diff --git a/node/monitor-theia/src/common/util.ts b/node/monitor-theia/src/common/util.ts index c06074f7..a73af7e6 100644 --- a/node/monitor-theia/src/common/util.ts +++ b/node/monitor-theia/src/common/util.ts @@ -1,4 +1,4 @@ -import { THEIACLOUD_SESSION_SECRET } from './env-variables'; +import { THEIA_CLOUD_SESSION_SECRET } from './env-variables'; export function isAuthorized(req: any): boolean { const bearerHeader = req.headers['authorization']; @@ -6,7 +6,7 @@ export function isAuthorized(req: any): boolean { const splitBearer = bearerHeader.split(' '); if (splitBearer.length === 2) { const bearerToken = splitBearer[1]; - if (bearerToken === process.env[THEIACLOUD_SESSION_SECRET]) { + if (bearerToken === process.env[THEIA_CLOUD_SESSION_SECRET]) { return true; } } diff --git a/node/monitor-theia/src/node/monitor-service.ts b/node/monitor-theia/src/node/monitor-service.ts index e4d3f5be..cfa1e273 100644 --- a/node/monitor-theia/src/node/monitor-service.ts +++ b/node/monitor-theia/src/node/monitor-service.ts @@ -12,9 +12,9 @@ export class DefaultTheiaCloudBackendMonitorService implements TheiaCloudBackend * Returns true if ran in theia cloud context */ isRunningOnTheiaCloud(): boolean { - const appId = process.env.THEIACLOUD_APP_ID; - const serviceUrl = process.env.THEIACLOUD_SERVICE_URL; - const sessionName = process.env.THEIACLOUD_SESSION_NAME; + const appId = process.env.THEIA_CLOUD_APP_ID; + const serviceUrl = process.env.THEIA_CLOUD_SERVICE_URL; + const sessionName = process.env.THEIA_CLOUD_SESSION_NAME; return appId && serviceUrl && sessionName ? true : false; } diff --git a/node/monitor/.vscode/launch.json b/node/monitor/.vscode/launch.json index cd276b80..4a3ed57a 100644 --- a/node/monitor/.vscode/launch.json +++ b/node/monitor/.vscode/launch.json @@ -13,8 +13,8 @@ "outFiles": ["${workspaceFolder}/dist/**/*.js"], "preLaunchTask": "${defaultBuildTask}", "env": { - "THEIACLOUD_MONITOR_ENABLE_ACTIVITY_TRACKER": "true", - "THEIACLOUD_SESSION_SECRET": "TestSecret" + "THEIA_CLOUD_MONITOR_ENABLE_ACTIVITY_TRACKER": "true", + "THEIA_CLOUD_SESSION_SECRET": "TestSecret" } }, { diff --git a/node/monitor/README.md b/node/monitor/README.md index 9c946c21..3e5394c0 100644 --- a/node/monitor/README.md +++ b/node/monitor/README.md @@ -10,16 +10,16 @@ For this, the extension reads environment variables to check the activation of e For an example on setting these environment variables, take a look at the `Run extension` launch config in the `.vscode/launch.json` file. ```json -"THEIACLOUD_MONITOR_PORT": "8081", -"THEIACLOUD_MONITOR_ENABLE_ACTIVITY_TRACKER": "true" +"THEIA_CLOUD_MONITOR_PORT": "8081", +"THEIA_CLOUD_MONITOR_ENABLE_ACTIVITY_TRACKER": "true" ``` ## List of modules -| Name | description | ENV to enable | -| --------------------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | -| MessagingModule | Allows the backend to send messages to be displayed to the user | (always enabled) | -| ActivityTrackerModule | Allows the backend to ask about the users last activity and show a warning if the pod is about to be timed out | THEIACLOUD_MONITOR_ENABLE_ACTIVITY_TRACKER | +| Name | description | ENV to enable | +| --------------------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | +| MessagingModule | Allows the backend to send messages to be displayed to the user | (always enabled) | +| ActivityTrackerModule | Allows the backend to ask about the users last activity and show a warning if the pod is about to be timed out | THEIA_CLOUD_MONITOR_ENABLE_ACTIVITY_TRACKER | ## Debugging the extension diff --git a/node/monitor/package-lock.json b/node/monitor/package-lock.json index 6bf3948e..3329c276 100644 --- a/node/monitor/package-lock.json +++ b/node/monitor/package-lock.json @@ -1,11 +1,11 @@ { - "name": "theiacloud-monitor", + "name": "theia-cloud-monitor", "version": "0.12.0-next", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "theiacloud-monitor", + "name": "theia-cloud-monitor", "version": "0.12.0-next", "license": "EPL-2.0", "dependencies": { diff --git a/node/monitor/package.json b/node/monitor/package.json index 528f1a55..b21bec7d 100644 --- a/node/monitor/package.json +++ b/node/monitor/package.json @@ -1,5 +1,5 @@ { - "name": "theiacloud-monitor", + "name": "theia-cloud-monitor", "displayName": "Theia Cloud Monitor extension", "description": "Monitor for Theia Cloud hosted tools", "version": "0.12.0-next", diff --git a/node/monitor/src/env-variables.ts b/node/monitor/src/env-variables.ts index a61603d1..47bc8c07 100644 --- a/node/monitor/src/env-variables.ts +++ b/node/monitor/src/env-variables.ts @@ -1,9 +1,9 @@ /** * List of environment variables that the extension uses */ -export const MONITOR_PORT = 'THEIACLOUD_MONITOR_PORT'; -export const MONITOR_ENABLE_ACTIVITY_TRACKER = 'THEIACLOUD_MONITOR_ENABLE_ACTIVITY_TRACKER'; -export const THEIACLOUD_SESSION_SECRET = 'THEIACLOUD_SESSION_SECRET'; +export const MONITOR_PORT = 'THEIA_CLOUD_MONITOR_PORT'; +export const MONITOR_ENABLE_ACTIVITY_TRACKER = 'THEIA_CLOUD_MONITOR_ENABLE_ACTIVITY_TRACKER'; +export const THEIA_CLOUD_SESSION_SECRET = 'THEIA_CLOUD_SESSION_SECRET'; /** * Utility function to check the value of an environment variable diff --git a/node/monitor/src/util/util.ts b/node/monitor/src/util/util.ts index 7a4b67fa..9969d8df 100644 --- a/node/monitor/src/util/util.ts +++ b/node/monitor/src/util/util.ts @@ -1,4 +1,4 @@ -import { getFromEnv, THEIACLOUD_SESSION_SECRET } from '../env-variables'; +import { getFromEnv, THEIA_CLOUD_SESSION_SECRET } from '../env-variables'; export function isAuthorized(req: any): boolean { const bearerHeader = req.headers['authorization']; @@ -6,7 +6,7 @@ export function isAuthorized(req: any): boolean { const splitBearer = bearerHeader.split(' '); if (splitBearer.length === 2) { const bearerToken = splitBearer[1]; - const sessionSecret = getFromEnv(THEIACLOUD_SESSION_SECRET); + const sessionSecret = getFromEnv(THEIA_CLOUD_SESSION_SECRET); if (bearerToken === sessionSecret) { return true; } diff --git a/node/testing-page/README.md b/node/testing-page/README.md index c9e32477..b1faf22c 100644 --- a/node/testing-page/README.md +++ b/node/testing-page/README.md @@ -1,6 +1,6 @@ -# TheiaCloud Testing App +# Theia Cloud Testing App -This folder contains a simple test app that allows to login via Keycloak and trigger various TheiaCloud endpoints (e.g. session start or stop). +This folder contains a simple test app that allows to login via Keycloak and trigger various Theia Cloud endpoints (e.g. session start or stop). ## Usage diff --git a/terraform/configurations/minikube_getting_started/minikube_getting_started.tf b/terraform/configurations/minikube_getting_started/minikube_getting_started.tf index 85be224d..003213c5 100644 --- a/terraform/configurations/minikube_getting_started/minikube_getting_started.tf +++ b/terraform/configurations/minikube_getting_started/minikube_getting_started.tf @@ -58,7 +58,7 @@ resource "kubernetes_persistent_volume" "minikube" { access_modes = ["ReadWriteOnce"] persistent_volume_source { host_path { - path = "/data/theiacloud" + path = "/data/theia-cloud" } } } diff --git a/terraform/modules/helm/main.tf b/terraform/modules/helm/main.tf index 7f461d86..3e512836 100644 --- a/terraform/modules/helm/main.tf +++ b/terraform/modules/helm/main.tf @@ -131,7 +131,7 @@ resource "helm_release" "theia-cloud-base" { repository = "https://eclipse-theia.github.io/theia-cloud-helm" chart = "theia-cloud-base" version = "0.11.1" - namespace = "theiacloud" + namespace = "theia-cloud" create_namespace = true set { @@ -147,7 +147,7 @@ resource "helm_release" "theia-cloud-crds" { repository = "https://eclipse-theia.github.io/theia-cloud-helm" chart = "theia-cloud-crds" version = "0.11.1" - namespace = "theiacloud" + namespace = "theia-cloud" create_namespace = true } @@ -231,7 +231,7 @@ resource "helm_release" "theia-cloud" { repository = "https://eclipse-theia.github.io/theia-cloud-helm" chart = "theia-cloud" version = "0.11.1" - namespace = "theiacloud" + namespace = "theia-cloud" create_namespace = true values = [ diff --git a/terraform/test-configurations/0_minikube-setup/minikube_test_cluster.tf b/terraform/test-configurations/0_minikube-setup/minikube_test_cluster.tf index 841debe7..8d5dd329 100644 --- a/terraform/test-configurations/0_minikube-setup/minikube_test_cluster.tf +++ b/terraform/test-configurations/0_minikube-setup/minikube_test_cluster.tf @@ -51,7 +51,7 @@ resource "kubernetes_persistent_volume" "minikube" { access_modes = ["ReadWriteOnce"] persistent_volume_source { host_path { - path = "/data/theiacloud" + path = "/data/theia-cloud" } } } diff --git a/terraform/test-configurations/1_theia-cloud-base/theia_cloud_base.tf b/terraform/test-configurations/1_theia-cloud-base/theia_cloud_base.tf index a6092b28..ab2de0ec 100644 --- a/terraform/test-configurations/1_theia-cloud-base/theia_cloud_base.tf +++ b/terraform/test-configurations/1_theia-cloud-base/theia_cloud_base.tf @@ -23,14 +23,14 @@ provider "helm" { resource "helm_release" "theia-cloud-crds" { name = "theia-cloud-crds" chart = "../../../../theia-cloud-helm/charts/theia-cloud-crds" - namespace = "theiacloud" + namespace = "theia-cloud" create_namespace = true } resource "helm_release" "theia-cloud-base" { name = "theia-cloud-base" chart = "../../../../theia-cloud-helm/charts/theia-cloud-base" - namespace = "theiacloud" + namespace = "theia-cloud" create_namespace = true set { diff --git a/terraform/test-configurations/2-01_try-now/theia_cloud.tf b/terraform/test-configurations/2-01_try-now/theia_cloud.tf index c0f40dd4..08d92883 100644 --- a/terraform/test-configurations/2-01_try-now/theia_cloud.tf +++ b/terraform/test-configurations/2-01_try-now/theia_cloud.tf @@ -26,7 +26,7 @@ provider "kubectl" { resource "helm_release" "theia-cloud" { name = "theia-cloud" chart = "../../../../theia-cloud-helm/charts/theia-cloud" - namespace = "theiacloud" + namespace = "theia-cloud" create_namespace = true values = [ @@ -87,7 +87,7 @@ resource "kubectl_manifest" "cdt-cloud-demo" { kind: AppDefinition metadata: name: cdt-cloud-demo - namespace: theiacloud + namespace: theia-cloud spec: downlinkLimit: 30000 image: theiacloud/cdt-cloud:v1.34.4 @@ -116,7 +116,7 @@ resource "kubectl_manifest" "coffee-editor" { kind: AppDefinition metadata: name: coffee-editor - namespace: theiacloud + namespace: theia-cloud spec: downlinkLimit: 30000 image: eu.gcr.io/kubernetes-238012/coffee-editor:v0.7.17 diff --git a/terraform/test-configurations/2-02_monitor/theia_cloud.tf b/terraform/test-configurations/2-02_monitor/theia_cloud.tf index 0070c19a..00c2ded5 100644 --- a/terraform/test-configurations/2-02_monitor/theia_cloud.tf +++ b/terraform/test-configurations/2-02_monitor/theia_cloud.tf @@ -28,7 +28,7 @@ provider "helm" { resource "helm_release" "theia-cloud" { name = "theia-cloud" chart = "../../../../theia-cloud-helm/charts/theia-cloud" - namespace = "theiacloud" + namespace = "theia-cloud" create_namespace = true values = [ diff --git a/terraform/test-configurations/2-03_try-now_paths/theia_cloud.tf b/terraform/test-configurations/2-03_try-now_paths/theia_cloud.tf index dcddac19..2fa637a9 100644 --- a/terraform/test-configurations/2-03_try-now_paths/theia_cloud.tf +++ b/terraform/test-configurations/2-03_try-now_paths/theia_cloud.tf @@ -26,7 +26,7 @@ provider "kubectl" { resource "helm_release" "theia-cloud" { name = "theia-cloud" chart = "../../../../theia-cloud-helm/charts/theia-cloud" - namespace = "theiacloud" + namespace = "theia-cloud" create_namespace = true values = [ @@ -100,7 +100,7 @@ resource "kubectl_manifest" "cdt-cloud-demo" { kind: AppDefinition metadata: name: cdt-cloud-demo - namespace: theiacloud + namespace: theia-cloud spec: downlinkLimit: 30000 image: theiacloud/cdt-cloud:v1.34.4 @@ -129,7 +129,7 @@ resource "kubectl_manifest" "coffee-editor" { kind: AppDefinition metadata: name: coffee-editor - namespace: theiacloud + namespace: theia-cloud spec: downlinkLimit: 30000 image: eu.gcr.io/kubernetes-238012/coffee-editor:v0.7.17 diff --git a/terraform/test-configurations/test.md b/terraform/test-configurations/test.md index 2df3dbd4..035956d7 100644 --- a/terraform/test-configurations/test.md +++ b/terraform/test-configurations/test.md @@ -8,7 +8,7 @@ Moreover the directory contains terraform configurations to install common Theia Run `terraform init` and `terraform apply` in both directories below: -- `0_minikube-setup` installs a minikube cluster with all required dependencies, including a Keycloak with a TheiaCloud realm, but without TheiaCloud. +- `0_minikube-setup` installs a minikube cluster with all required dependencies, including a Keycloak with a TheiaCloud realm, but without Theia Cloud. - `1_theia-cloud-base` installs theia cloud base ```bash