package api.v1.environment

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Create (CreateRequest, CreateResponse)

  service.proto:9

  message CreateRequest

  service.proto:18

  • string environment_id = 1

  • repeated Update initializers = 2

  • string cluster_id = 3

  • string namespace_template = 4

    Namespace template is used to generate the namespace name when configuring resources. Default is to set the namespace equal to the project name. Default value is: {{ .Project.Name }} Valid template properties are: .Project.Name - name of the project .Environment.Name - name of the environment.

  • bool ephemeral = 5

    If true, the environment will be marked as ephemeral. It is possible for developers to create ephemeral environments.

  message CreateResponse

  service.proto:34

  (message has no fields)

• rpc Update (UpdateRequest, UpdateResponse)

  service.proto:10

  message UpdateRequest

  service.proto:36

  • string environment_id = 1

  • repeated Update updates = 2

  message UpdateResponse

  service.proto:41

  (message has no fields)

• rpc Delete (DeleteRequest, DeleteResponse)

  service.proto:11

  message DeleteRequest

  service.proto:43

  • string environment_id = 1

  • bool force = 2

    Force delete all running capsules in the enviornment. If false, the request will be aborted if any capsules is running in the environment.

  message DeleteResponse

  service.proto:51

  (message has no fields)

• rpc List (ListRequest, ListResponse)

  service.proto:13

  List available environments.

  message ListRequest

  service.proto:54

  Request for listing available environments.

  • optional model.Pagination pagination = 2

    Pagination options.

  • bool exclude_ephemeral = 3

    Exclude ephemeral environments in the list.

  • string project_filter = 4

    Get environments for a specific project.

  message ListResponse

  service.proto:64

  Response for listing available environments.

  • repeated Environment environments = 1

    List of environments.

  • string platform_version = 2

    The version of the Rig-platform.

• rpc GetNamespaces (GetNamespacesRequest, GetNamespacesResponse)

  service.proto:14

  message GetNamespacesRequest

  service.proto:82

  • repeated ProjectEnvironment project_envs = 1

  message GetNamespacesResponse

  service.proto:86

  • repeated ProjectEnvironmentNamespace namespaces = 2

• rpc Get (GetRequest, GetResponse)

  service.proto:15

  message GetRequest

  service.proto:90

  • string environment_id = 1

  message GetResponse

  service.proto:94

  • optional Environment environment = 1

Environment model.

Used in: GetResponse, ListResponse

• string environment_id = 1

  ID of the environment.

• string operator_version = 3

  The version of the Rig-operator CRD for this environment.

• string cluster_id = 4

  ID of the backing cluster.

• string namespace_template = 5

  Namespace template is used to generate the namespace name when configuring resources. Default is to set the namespace equal to the project name.

• bool ephemeral = 6

  If true, the environment is deletable by developer users, and can be deleted with capsules running.

• repeated string active_projects = 7

  Active Projects. These projects can deploy capsules to this environment. This is overridden by a true the global flag.

• bool global = 8

  If true, the environment is available to all projects.

Used in: GetNamespacesRequest

• string project_id = 1

• string environment_id = 2

Used in: GetNamespacesResponse

• string project_id = 1

• string environment_id = 2

• string namespace = 3

• optional platform.v1.Environment spec = 1

• optional model.RevisionMetadata metadata = 2

Used in: CreateRequest, UpdateRequest

• oneof field

  • string add_project = 2

  • string remove_project = 3

  • bool set_global = 4