@gitpod/gitpod-protocol 0.1.5-test.9 → 0.1.5-tweak-workspaceconfig-origin-docs-fork.0

package/src/workspace-cluster.ts

@@ -0,0 +1,96 @@
+/**
+ * Copyright (c) 2020 Gitpod GmbH. All rights reserved.
+ * Licensed under the GNU Affero General Public License (AGPL).
+ * See License-AGPL.txt in the project root for license information.
+ */
+
+import * as fs from 'fs';
+import { filePathTelepresenceAware } from './env';
+import { DeepPartial } from "./util/deep-partial";
+import { PermissionName } from './permission';
+
+export interface WorkspaceCluster {
+    // Name of the workspace cluster.
+    // This is the string set in each
+    // Must be identical to the installationShortname of the cluster it represents!
+    name: string;
+
+    // URL of the cluster's ws-manager API
+    url: string;
+
+    // TLS contains the keys and certificates necessary to use mTLS between server and clients
+    tls?: TLSConfig;
+
+    // Current state of the cluster
+    state: WorkspaceClusterState;
+
+    // Maximum value score can reach for this cluster
+    maxScore: number;
+
+    // Score used for cluster selection when starting workspace instances
+    score: number;
+
+    // True if this bridge should control this cluster
+    govern: boolean;
+
+    // An optional set of constraints that limit who can start workspaces on the cluster
+    admissionConstraints?: AdmissionConstraint[];
+
+    // An optional set of admission preferences that guide cluster selection
+    admissionPreferences?: AdmissionPreference[];
+}
+
+export type WorkspaceClusterState = "available" | "cordoned" | "draining";
+export interface TLSConfig {
+    // the CA shared between client and server (base64 encoded)
+    ca: string;
+    // the private key (base64 encoded)
+    key: string;
+    // the certificate signed with the shared CA (base64 encoded)
+    crt: string;
+}
+export namespace TLSConfig {
+    export const loadFromBase64File = (path: string): string => fs.readFileSync(filePathTelepresenceAware(path)).toString("base64");
+}
+export type WorkspaceClusterWoTLS = Omit<WorkspaceCluster, "tls">;
+export type WorkspaceManagerConnectionInfo = Pick<WorkspaceCluster, "name" | "url" | "tls">;
+
+export type AdmissionConstraint = AdmissionConstraintFeaturePreview | AdmissionConstraintHasRole | AdmissionConstraintHasUserLevel;
+export type AdmissionConstraintFeaturePreview = { type: "has-feature-preview" };
+export type AdmissionConstraintHasRole = { type: "has-permission", permission: PermissionName };
+export type AdmissionConstraintHasUserLevel = { type: "has-user-level", level: string };
+
+export type AdmissionPreference = AdmissionPreferenceUserLevel;
+export type AdmissionPreferenceUserLevel = { type: 'user-level', level: string };
+
+
+export const WorkspaceClusterDB = Symbol("WorkspaceClusterDB");
+export interface WorkspaceClusterDB {
+    /**
+     * Stores the given WorkspaceCluster to the cluster-local DB in a consistent manner.
+     * If there already is an entry with the same name it's merged and updated with the given state.
+     * @param cluster
+     */
+    save(cluster: WorkspaceCluster): Promise<void>;
+
+    /**
+     * Deletes the cluster identified by this name, if any.
+     * @param name
+     */
+    deleteByName(name: string): Promise<void>;
+
+    /**
+     * Finds a WorkspaceCluster with the given name. If there is none, `undefined` is returned.
+     * @param name
+     */
+    findByName(name: string): Promise<WorkspaceCluster | undefined>;
+
+    /**
+     * Lists all WorkspaceClusterWoTls for which the given predicate is true (does not return TLS for size/speed concerns)
+     * @param predicate
+     */
+    findFiltered(predicate: DeepPartial<WorkspaceClusterFilter>): Promise<WorkspaceClusterWoTLS[]>;
+}
+export interface WorkspaceClusterFilter extends Pick<WorkspaceCluster, "state" | "govern" | "url"> {
+    minScore: number;
+}

package/src/workspace-instance.ts

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2020 TypeFox GmbH. All rights reserved.
+ * Copyright (c) 2020 Gitpod GmbH. All rights reserved.
  * Licensed under the GNU Affero General Public License (AGPL).
  * See License-AGPL.txt in the project root for license information.
  */
@@ -23,16 +23,22 @@ export interface WorkspaceInstance {
     // The time an instance has switched phase to 'Running'
     startedTime?: string;
 
+    // The time an instance has switched phase to 'Stopping' */
+    stoppingTime?: string;
+
     // The time an instance has switched phase to 'Stopped' */
     stoppedTime?: string;
 
     // ideUrl is the URL at which the workspace is available on the internet
+    // Note: this is nitially empty, filled during starting process!
     ideUrl: string;
 
     // region is the name of the workspace cluster this instance runs in
+    // Note: this is nitially empty, filled during starting process!
     region: string;
 
     // workspaceImage is the name of the Docker image this instance runs
+    // Note: this is nitially empty, filled during starting process!
     workspaceImage: string;
 
     // status is the latest status of the instance that we're aware of
@@ -70,6 +76,12 @@ export interface WorkspaceInstanceStatus {
     // nodeName is the name of the node the instance was scheduled onto
     nodeName?: string;
 
+    // podName is the name of the pod of this instance
+    podName?: string;
+
+    // nodeIp is the IP of the node the workspace is running on
+    nodeIp?: string;
+
     // ownerToken is the token one needs to access the workspace. Its presence is checked by ws-proxy.
     ownerToken?: string;
 }
@@ -77,7 +89,7 @@ export interface WorkspaceInstanceStatus {
 // WorkspaceInstancePhase describes a high-level state of a workspace instance
 export type WorkspaceInstancePhase =
     // unknown indicates an issue within the system in that it cannot determine the actual phase of
-	// a workspace. This phase is usually accompanied by an error.
+    // a workspace. This phase is usually accompanied by an error.
     "unknown" |
 
     // Preparing means that we haven't actually started the workspace instance just yet, but rather
@@ -85,21 +97,21 @@ export type WorkspaceInstancePhase =
     "preparing" |
 
     // Pending means the workspace does not yet consume resources in the cluster, but rather is looking for
-	// some space within the cluster. If for example the cluster needs to scale up to accomodate the
-	// workspace, the workspace will be in Pending state until that happened.
+    // some space within the cluster. If for example the cluster needs to scale up to accomodate the
+    // workspace, the workspace will be in Pending state until that happened.
     "pending" |
 
     // Creating means the workspace is currently being created. Thati includes downloading the images required
-	// to run the workspace over the network. The time spent in this phase varies widely and depends on the current
-	// network speed, image size and cache states.
+    // to run the workspace over the network. The time spent in this phase varies widely and depends on the current
+    // network speed, image size and cache states.
     "creating" |
 
     // Initializing is the phase in which the workspace is executing the appropriate workspace initializer (e.g. Git
-	// clone or backup download). After this phase one can expect the workspace to either be Running or Failed.
+    // clone or backup download). After this phase one can expect the workspace to either be Running or Failed.
     "initializing" |
 
     // Running means the workspace is able to actively perform work, either by serving a user through Theia,
-	// or as a headless workspace.
+    // or as a headless workspace.
     "running" |
 
     // Interrupted is an exceptional state where the container should be running but is temporarily unavailable.
@@ -122,9 +134,6 @@ export interface WorkspaceInstanceConditions {
     // PullingImages marks if the workspace is currently pulling its images. This condition can only be set during PhaseCreating
     pullingImages?: boolean
 
-    // ServiceExists denotes if the workspace theia-/ports- services exist. This condition will be true if either of the two services exist.
-    serviceExists?: boolean
-
     // deployed marks that a workspace instance was sent/deployed at a workspace manager
     deployed?: boolean;
 
@@ -133,6 +142,12 @@ export interface WorkspaceInstanceConditions {
 
     // ISO8601 timestamp when the first user activity was registered in the frontend. Only set if the workspace is running.
     firstUserActivity?: string;
+
+    // headless_task_failed indicates that a headless workspace task failed
+    headlessTaskFailed?: string;
+
+    // stopped_by_request is true if the workspace was stopped using a StopWorkspace call
+    stoppedByRequest?: boolean;
 }
 
 // AdmissionLevel describes who can access a workspace instance and its ports.
@@ -146,9 +161,6 @@ export interface WorkspaceInstancePort {
     // The outward-facing port number
     port: number;
 
-    // An optional inward-facing port number. If not present we'll use port.
-    targetPort?: number;
-
     // The visiblity of this port. Optional for backwards compatibility.
     visibility?: PortVisibility;
 
@@ -186,8 +198,18 @@ export interface WorkspaceInstanceRepoStatus {
 // WorkspaceInstanceConfiguration contains all per-instance configuration
 export interface WorkspaceInstanceConfiguration {
     // theiaVersion is the version of Theia this workspace instance uses
-    theiaVersion: string;
+    // @deprected: replaced with the ideImage field
+    theiaVersion?: string;
 
     // feature flags are the lowercase feature-flag names as passed to ws-manager
     featureFlags?: NamedWorkspaceFeatureFlag[];
-}
+
+    // ideImage is the ref of the IDE image this instance uses.
+    ideImage: string;
+
+    // desktopIdeImage is the ref of the desktop IDE image this instance uses.
+    desktopIdeImage?: string
+
+    // supervisorImage is the ref of the supervisor image this instance uses.
+    supervisorImage?: string;
+}

package/src/wsready.ts

@@ -1,10 +1,10 @@
 /**
- * Copyright (c) 2020 TypeFox GmbH. All rights reserved.
+ * Copyright (c) 2021 Gitpod GmbH. All rights reserved.
  * Licensed under the GNU Affero General Public License (AGPL).
  * See License-AGPL.txt in the project root for license information.
  */
 
-// generated using github.com/32leaves/bel on 2020-06-11 14:47:30.351829728 +0000 UTC m=+0.002956090
+// generated using github.com/32leaves/bel on 2021-11-04 12:16:53.917570766 +0000 UTC m=+0.006002884
 // DO NOT MODIFY
 
 export enum WorkspaceInitSource {

package/lib/util/without.d.ts

@@ -1,7 +0,0 @@
-/**
- * Copyright (c) 2020 TypeFox GmbH. All rights reserved.
- * Licensed under the GNU Affero General Public License (AGPL).
- * See License-AGPL.txt in the project root for license information.
- */
-export declare type Without<T, K> = Pick<T, Exclude<keyof T, K>>;
-//# sourceMappingURL=without.d.ts.map

package/lib/util/without.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"without.d.ts","sourceRoot":"","sources":["../../src/util/without.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,oBAAY,OAAO,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC"}

package/lib/util/without.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"without.js","sourceRoot":"","sources":["../../src/util/without.ts"],"names":[],"mappings":";AAAA;;;;GAIG"}