Add internal API scoping mechanism and descriptions

components/schemas/containers/config/ContainerRuntime.yml

@@ -85,6 +85,8 @@ properties:
         - CAP_LEASE
         - CAP_WAKE_ALARM
     description: A list of linux kernel capabilites for the given container.
+  internal_api:
+    $ref: ./runtime/RuntimeInternalApi.yml
   workdir:
     type: string
     description: Configure the working directory for the given container.

components/schemas/containers/config/runtime/RuntimeInternalApi.yml

@@ -0,0 +1,17 @@
+title: RuntimeInternalApi
+description: Configuration options for the internal API access within instances of this container.
+type: object
+properties:
+  scope:
+    oneOf:
+      - type: array
+        description: Scopes determine which set of endpoints instances of this container can reach over the internal API.
+        items:
+          type: string
+          enum:
+            - self
+            - environment
+            - networks
+            - server
+            - notifications
+      - type: "null"

internal/api.yml

@@ -57,8 +57,8 @@ paths:
     $ref: paths/server/server.yml
   /v1/server/instances:
     $ref: paths/server/instances.yml
-  /v1/server/instances/telemetry:
-    $ref: paths/server/instance-telemetry.yml
+  /v1/server/external-volumes:
+    $ref: paths/server/external-volumes.yml
   /v1/server/containers:
     $ref: paths/server/containers.yml
   /v1/server/images:
@@ -80,10 +80,6 @@ paths:
   /v1/containers/domains:
     $ref: paths/container/domains.yml
 
-  # Conductor
-  /v1/conductor/tasks:
-    $ref: paths/conductor/tasks.yml
-
   # HA
   /v1/ha/checkin:
     $ref: paths/ha/checkin.yml
@@ -94,10 +90,6 @@ paths:
   /v1/monitoring/events:
     $ref: paths/monitoring/events.yml
 
-  # VPN
-  /v1/vpn/login:
-    $ref: paths/vpn/login.yml
-
   # SDN
   /v1/sdn/networks:
     $ref: paths/sdn/networks.yml
@@ -111,8 +103,6 @@ paths:
     $ref: paths/virtual-machine/virtual-machine.yml
   /v1/virtual-machine/domains:
     $ref: paths/virtual-machine/domains.yml
-  /v1/virtual-machine/gateways:
-    $ref: paths/virtual-machine/gateways.yml
 
   # Object Cache
   /v1/object-cache:

internal/paths/container/certificates.yml

@@ -1,9 +1,14 @@
 get:
   operationId: "getContainerCertificates"
   summary: List Container Certificates
-  description: Get the TLS certificates associated with the domains pointed at this container.
+  description: |
+    Get the TLS certificates associated with the domains pointed at this container.
+
+    Requires the `self` scope to be set on the container runtime config.
   tags:
     - Containers
+  x-cycle-scopes:
+    - self
   parameters:
     - name: container-id
       in: query

internal/paths/container/container.yml

@@ -1,9 +1,14 @@
 get:
   operationId: "getContainer"
   summary: Get Container
-  description: Gets a container. By default will grab the container of this instance, but a `container-id`` parameter can be passed to grab any other container in the same environment.
+  description: |
+    Gets a container. By default will grab the container of this instance, but a `container-id`` parameter can be passed to grab any other container in the same environment.
+
+    Requires the `self` scope to be set on the container runtime config.
   tags:
     - Containers
+  x-cycle-scopes:
+    - self
   parameters:
     - name: container-id
       in: query

internal/paths/container/domains.yml

@@ -1,9 +1,14 @@
 get:
   operationId: "getContainerDomains"
   summary: List Container Domains
-  description: Get the domains pointed at a container.
+  description: |
+    Get the domains pointed at a container.
+
+    Requires the `self` scope to be set on the container runtime config.
   tags:
     - Containers
+  x-cycle-scopes:
+    - self
   parameters:
     - name: container-id
       in: query

internal/paths/container/instances.yml

@@ -1,10 +1,15 @@
 get:
   operationId: "getContainerInstances"
   summary: Get Container Instances
-  description: Gets the instances of a container. By default will grab the instances of the same container, but a `container-id`` parameter can be passed to grab any other container instances in the same environment.
+  description: |
+    Gets the instances of a container. By default will grab the instances of the same container, but a `container-id`` parameter can be passed to grab any other container instances in the same environment.
+
+    Requires the `self` scope to be set on the container runtime config.
   tags:
     - Containers
     - Instances
+  x-cycle-scopes:
+    - self
   parameters:
     - name: container-id
       in: query

internal/paths/environment/containers.yml

@@ -1,9 +1,14 @@
 get:
   operationId: "getEnvironmentContainers"
   summary: List Environment Containers
-  description: Lists all Containers that are part of the same Environment as this Instance.
+  description: |
+    Lists all Containers that are part of the same Environment as this Instance.
+
+    Requires the `environment` scope to be set on the container runtime config.
   tags:
     - Environments
+  x-cycle-scopes:
+    - environment
   parameters: []
   responses:
     default:

internal/paths/environment/environment.yml

@@ -3,8 +3,12 @@ get:
   summary: Get Environment
   description: |
     Gets the Environment that this instance is a part of.
+
+    Requires the `environment` scope to be set on the container runtime config.
   tags:
     - Environments
+  x-cycle-scopes:
+    - environment
   parameters: []
   responses:
     default:

internal/paths/environment/instances.yml

@@ -1,10 +1,15 @@
 get:
   operationId: "getEnvironmentInstances"
   summary: List Environment Instances
-  description: Lists all instances present in this instance's environment.
+  description: |
+    Lists all instances present in this instance's environment.
+
+    Requires the `environment` scope to be set on the container runtime config.
   tags:
     - Environments
     - Instances
+  x-cycle-scopes:
+    - environment
   parameters: []
   responses:
     default:

internal/paths/environment/ips.yml

@@ -1,9 +1,14 @@
 get:
   operationId: "getEnvironmentIPs"
   summary: List Environment IPs
-  description: Lists the IPs associated with this Instance's Environment.
+  description: |
+    Lists the IPs associated with this Instance's Environment.
+
+    Requires the `environment` scope to be set on the container runtime config.
   tags:
     - Environments
+  x-cycle-scopes:
+    - environment
   parameters: []
   responses:
     default:

internal/paths/environment/lbtelemetry.yml

@@ -1,9 +1,14 @@
 post:
   operationId: "submitLoadBalancerTelemetry"
   summary: Submit Environment Load Balancer Telemetry
-  description: Submit load balancer telemetry data.
+  description: |
+    Submit load balancer telemetry data.
+
+    Requires the `environment` scope to be set on the container runtime config.
   tags:
     - Environments
+  x-cycle-scopes:
+    - environment
   parameters: []
   requestBody:
     required: true

internal/paths/environment/scoped-variables.yml

@@ -3,8 +3,12 @@ get:
   summary: Get Environment Scoped Variables
   description: |
     Gets the scoped variables that are accessible to this instance via internal API.
+
+    Requires the `environment` scope to be set on the container runtime config.
   tags:
     - Scoped Variables
+  x-cycle-scopes:
+    - environment
   parameters: []
   responses:
     default:

internal/paths/environment/services.yml

@@ -1,9 +1,14 @@
 get:
   operationId: "getEnvironmentServices"
   summary: List Environment Services
-  description: Lists the services containers/instances that are in the same environment as this instance.
+  description: |
+    Lists the services containers/instances that are in the same environment as this instance.
+
+    Requires the `environment` scope to be set on the container runtime config.
   tags:
     - Environments
+  x-cycle-scopes:
+    - environment
   parameters: []
   responses:
     default:

internal/paths/environment/virtual-machines.yml

@@ -2,9 +2,13 @@ get:
   operationId: "getEnvironmentVirtualMachines"
   summary: Get Environment Virtual Machines
   description: |
-     Returns a list of virtual machines that are in the same environment as this instance.
+    Returns a list of virtual machines that are in the same environment as this instance.
+
+    Requires the `environment` scope to be set on the container runtime config.
   tags:
     - Environments
+  x-cycle-scopes:
+    - environment
   parameters: []
   responses:
     default:

internal/paths/ha/checkin.yml

@@ -4,8 +4,12 @@ post:
   description: |
     Hit this endpoint every 30 seconds to check in and have the platform select and maintain a primary instance.
     Every instance you wish to be considered for a primary should hit this endpoint roughly every 30 seconds. The platform will choose one instance as the primary, and it will continue to be the primary until it stops checking in. If a primary stops checking in, a secondary will be selected to be promoted to primary.
+
+    Does not require a scope, but `config.deploy.ha_elections` must be enabled on this container to access this endpoint.
   tags:
     - High Availability
+  x-cycle-scopes:
+    - none
   requestBody:
     required: true
     content: