From e6e89ca67af88157b6e0b7e17ef0c61e861fb6c5 Mon Sep 17 00:00:00 2001 From: Dylan Arbour Date: Wed, 3 Aug 2022 16:23:32 -0400 Subject: [PATCH 1/2] chore: SCC to SCN change --- .../configure-capabilities.md | 9 +++++---- .../cloud-deployment/configure-storage.md | 16 +++++++-------- .../cloud-deployment/configure-webhooks.md | 10 +++++----- ...stall-compute-in-your-cloud-environment.md | 2 +- .../concepts/data-plane-vs-control-plane.md | 8 ++++---- .../custom-function-templates.md | 8 ++++---- .../customizing-functions/custom-libraries.md | 9 ++++----- .../quickstart/client-libraries/golang.md | 2 +- .../compute/quickstart/run-compute-locally.md | 20 +++++++++---------- 9 files changed, 42 insertions(+), 42 deletions(-) diff --git a/website/docs/compute/cloud-deployment/configure-capabilities.md b/website/docs/compute/cloud-deployment/configure-capabilities.md index 2b5b5b8bf..692d8fe62 100755 --- a/website/docs/compute/cloud-deployment/configure-capabilities.md +++ b/website/docs/compute/cloud-deployment/configure-capabilities.md @@ -11,7 +11,8 @@ Compute functions can access a number of capabilities: You can configure each capability. If you disable all capabilities, your users' functions will not be able to access the "outside world" in any way. -To configure capabilities, edit the `scc-config.yaml` file that `subo` created for you in your `suborbital/config` directory: +To configure capabilities, edit the `scn-config.yaml` file that `subo` created for you in your `suborbital/config` directory: + ```yaml networkRules: &networkRules allowIPs: false @@ -19,8 +20,8 @@ networkRules: &networkRules allowHTTP: true blockedDomains: - "*.cluster.local" - - "scc-controlplane-service" - - "scc-builder-service" + - "scn-controlplane-service" + - "scn-builder-service" capabilities: logger: @@ -41,4 +42,4 @@ capabilities: When you run `subo compute deploy core`, your installation will use the configuration file. If you do not create a config file, then the above default is used. The defaults are designed to be a sane configuration for the average use-case. -More capability types are being developed and will be available in upcoming versions. \ No newline at end of file +More capability types are being developed and will be available in upcoming versions. diff --git a/website/docs/compute/cloud-deployment/configure-storage.md b/website/docs/compute/cloud-deployment/configure-storage.md index ba767c41d..1172dfa99 100644 --- a/website/docs/compute/cloud-deployment/configure-storage.md +++ b/website/docs/compute/cloud-deployment/configure-storage.md @@ -2,7 +2,7 @@ By default, Compute will store compiled functions and function source code on the local storage in your Kubernetes cluster. For greater scalability, Compute can be configured to store artifacts in cloud-based object storage like Amazon S3 or Google Cloud Storage. -To configure a storage bucket, provide the `SCC_STORAGE_PATH` environment variable to both the control plane and builder, e.g. `s3://my-bucket` for Amazon S3 or `gs://my-bucket` for Google Cloud Storage. For Kubernetes deployments, this is done in `.suborbital/scc-controlplane-deployment.yaml` under the `controlplane` and `builder` containers sections, and for local docker-compose deployments, this is done in `docker-compose.yaml` under the `scc-control-plane` and `scc-builder` services. +To configure a storage bucket, provide the `SCN_STORAGE_PATH` environment variable to both the control plane and builder, e.g. `s3://my-bucket` for Amazon S3 or `gs://my-bucket` for Google Cloud Storage. For Kubernetes deployments, this is done in `.suborbital/scn-controlplane-deployment.yaml` under the `controlplane` and `builder` containers sections, and for local docker-compose deployments, this is done in `docker-compose.yaml` under the `scn-controlplane` and `scn-builder` services. ## Authentication @@ -18,7 +18,7 @@ GCS expects to read a service account credentials file, so those credentials mus #### Kubernetes deployment -Create `.suborbital/scc-gcs-credentials.yaml`, providing the base64 encoded contents of your `service-account-file.json`: +Create `.suborbital/scn-gcs-credentials.yaml`, providing the base64 encoded contents of your `service-account-file.json`: ```yaml apiVersion: v1 @@ -38,11 +38,11 @@ Mount the secret and provide the `GOOGLE_APPLICATION_CREDENTIALS` environment va ```yaml containers: - name: controlplane - image: suborbital/scc-control-plane:v0.3.0 + image: suborbital/scn-controlplane:v0.3.3 command: ["controlplane"] env: - - name: SCC_STORAGE_PATH + - name: SCN_STORAGE_PATH value: "gs://your-storage-bucket" - name: GOOGLE_APPLICATION_CREDENTIALS value: "/etc/gcp/sa_credentials.json" @@ -56,11 +56,11 @@ containers: readOnly: true - name: builder - image: suborbital/scc-builder:v0.3.0 + image: suborbital/scn-builder:v0.3.3 command: ["builder"] env: - - name: SCC_STORAGE_PATH + - name: SCN_STORAGE_PATH value: "gs://your-storage-bucket" - name: GOOGLE_APPLICATION_CREDENTIALS value: "/etc/gcp/sa_credentials.json" @@ -74,9 +74,9 @@ containers: readOnly: true volumes: - - name: scc-config + - name: scn-config configMap: - name: scc-config + name: scn-config - name: gcs-service-account-credentials-volume secret: secretName: gcs-service-account-credentials diff --git a/website/docs/compute/cloud-deployment/configure-webhooks.md b/website/docs/compute/cloud-deployment/configure-webhooks.md index 95cbc8889..057b406ee 100644 --- a/website/docs/compute/cloud-deployment/configure-webhooks.md +++ b/website/docs/compute/cloud-deployment/configure-webhooks.md @@ -2,17 +2,17 @@ Certain actions in Compute can trigger webhooks to notify other services of the event. The receivers of webhooks get contextually relevant information about the request Compute receiver. By default, no webhooks are configured. -You can set your own webhooks in the `scc-config.yaml` file that `subo` created for you in your `suborbital/config` directory. +You can set your own webhooks in the `scn-config.yaml` file that `subo` created for you in your `suborbital/config` directory. ## Configuration options -The `webhooks` stanza in `scc-config.yaml` consists of a top level `webhooks` object with a list of entries. +The `webhooks` stanza in `scn-config.yaml` consists of a top level `webhooks` object with a list of entries. Each entry has an `id` referencing one of the predefined [hook points](#hook-points) and a list of **one or more** HTTP `targets`, which consist of a `url`, `method`, and dictionary of `headers` (optional). ## Examples A simple inline example: -```yaml title=scc-config.yaml +```yaml title=scn-config.yaml capabilities: # ... @@ -26,7 +26,7 @@ webhooks: ``` An example with shared headers and multiple targets for a single hook point: -```yaml title=scc-config.yaml +```yaml title=scn-config.yaml commonHeaders: &commonHeaders 'Authorization': 'Bearer d2UncmUgaGlyaW5nCg==' @@ -61,4 +61,4 @@ webhooks: "version": "v1.0.0" } } -``` \ No newline at end of file +``` diff --git a/website/docs/compute/cloud-deployment/install-compute-in-your-cloud-environment.md b/website/docs/compute/cloud-deployment/install-compute-in-your-cloud-environment.md index 554ce3273..c39d653ad 100755 --- a/website/docs/compute/cloud-deployment/install-compute-in-your-cloud-environment.md +++ b/website/docs/compute/cloud-deployment/install-compute-in-your-cloud-environment.md @@ -31,7 +31,7 @@ kubectl get svc -n suborbital ## Set up DNS -When you deploy, a `LoadBalancer` is created for the builder called `scc-builder-service`. You should wait until an external IP address is provisioned for the service (use the `get svc` command above to check), and then create a DNS `A` record that matches the domain name you entered during setup. This will allow the builder to automatically provision a TLS certificate and connect with the [code editor](../integrate-the-function-editor/code-editor.md) securely. +When you deploy, a `LoadBalancer` is created for the builder called `scn-builder-service`. You should wait until an external IP address is provisioned for the service (use the `get svc` command above to check), and then create a DNS `A` record that matches the domain name you entered during setup. This will allow the builder to automatically provision a TLS certificate and connect with the [code editor](../integrate-the-function-editor/code-editor.md) securely. ## What's next diff --git a/website/docs/compute/concepts/data-plane-vs-control-plane.md b/website/docs/compute/concepts/data-plane-vs-control-plane.md index 2b71fff6a..271b500bb 100755 --- a/website/docs/compute/concepts/data-plane-vs-control-plane.md +++ b/website/docs/compute/concepts/data-plane-vs-control-plane.md @@ -4,16 +4,16 @@ There are two components of Compute: the Data Plane and the Control Plane. ## Data Plane -The "data plane" is the component that actually **executes** your users' functions, and it is comprised of an auto-scaled group of containers running [Atmo](https://github.com/suborbital/atmo). In your cluster, Atmo will be running in a pod called `scc-atmo`. +The "data plane" is the component that actually **executes** your users' functions, and it is comprised of an auto-scaled group of containers running [Atmo](https://github.com/suborbital/atmo). In your cluster, Atmo will be running in a pod called `scn-atmo`. The Atmo instances are run in 'headless' mode, which means they load configuration from a remote source, the control plane in this case. ## Control Plane -The Control Plane is comprised of two components; `scc-control-plane` and `scc-builder`. These two components are responsible for administering the cluster of Atmo instances and your users' functions, respectively. +The Control Plane is comprised of two components; `scn-controlplane` and `scn-builder`. These two components are responsible for administering the cluster of Atmo instances and your users' functions, respectively. -* `scc-builder` is the component that builds your users' functions and provides the embedded code editor. It can compile various languages to WebAssembly, it powers the [code editor](../integrate-the-function-editor/code-editor.md), and it provides CI/CD functionality for your users' code. -* `scc-control-plane` acts as a 'director' for Atmo, and controls things like autoscaling, collecting usage and error metrics, connecting to the Suborbital Telemetry service, and providing administrative APIs. It also manages the functions kept in your storage bucket. +* `scn-builder` is the component that builds your users' functions and provides the embedded code editor. It can compile various languages to WebAssembly, it powers the [code editor](../integrate-the-function-editor/code-editor.md), and it provides CI/CD functionality for your users' code. +* `scn-controlplane` acts as a 'director' for Atmo, and controls things like autoscaling, collecting usage and error metrics, connecting to the Suborbital Telemetry service, and providing administrative APIs. It also manages the functions kept in your storage bucket. :::info The control plane connects to `https://api.suborbital.network`, our authentication, billing, metadata, and telemetry service. An environment token is needed for the control plane to operate. diff --git a/website/docs/compute/customizing-functions/custom-function-templates.md b/website/docs/compute/customizing-functions/custom-function-templates.md index 172adee0e..ff7e4298f 100755 --- a/website/docs/compute/customizing-functions/custom-function-templates.md +++ b/website/docs/compute/customizing-functions/custom-function-templates.md @@ -24,13 +24,13 @@ Edit `templates/rust/src/lib.rs.tmpl` to change what your users will see when th ## Configuring Compute -To use the custom templates in your Compute installation, the `SCC_TEMPLATES_REPO` environment variable must be set on the builder service. +To use the custom templates in your Compute installation, the `SCN_TEMPLATES_REPO` environment variable must be set on the builder service. -- For a local deployment, edit `docker-compose.yml` to add `SCC_TEMPLATES_REPO:` to the builder with the value set to your fork \(e.g. `acmeco/runnable-templates`\) -- For a cloud deployment, edit `suborbital/scc-controlplane.yaml`, and add the following to the `builder` container's `environment`: +- For a local deployment, edit `docker-compose.yml` to add `SCN_TEMPLATES_REPO:` to the builder with the value set to your fork \(e.g. `acmeco/runnable-templates`\) +- For a cloud deployment, edit `suborbital/scn-controlplane.yaml`, and add the following to the `builder` container's `environment`: ```yaml -- name: SCC_TEMPLATES_REPO +- name: SCN_TEMPLATES_REPO value: "{your fork}" ``` diff --git a/website/docs/compute/customizing-functions/custom-libraries.md b/website/docs/compute/customizing-functions/custom-libraries.md index 21524421f..56dd4b202 100755 --- a/website/docs/compute/customizing-functions/custom-libraries.md +++ b/website/docs/compute/customizing-functions/custom-libraries.md @@ -43,17 +43,16 @@ npm publish --access public - ## Configuring Compute Since your custom library is listed as a dependency of the template project, it will be installed when your users' functions are built for the first time. -In your Compute installation, you will need to configure the `SCC_TEMPLATES_REPO` environment variable. +In your Compute installation, you will need to configure the `SCN_TEMPLATES_REPO` environment variable. -- For a local deployment, edit `docker-compose.yml` to add `SCC_TEMPLATES_REPO:` to the builder with the value set to your fork \(e.g. `acmeco/runnable-templates`\) -- For a cloud deployment, edit `suborbital/scc-controlplane.yaml`, and add the following to the `builder` container's `environment`: +- For a local deployment, edit `docker-compose.yml` to add `SCN_TEMPLATES_REPO:` to the builder with the value set to your fork \(e.g. `acmeco/runnable-templates`\) +- For a cloud deployment, edit `suborbital/scn-controlplane.yaml`, and add the following to the `builder` container's `environment`: ```yaml - - name: SCC_TEMPLATES_REPO + - name: SCN_TEMPLATES_REPO value: "{your fork}" ``` diff --git a/website/docs/compute/quickstart/client-libraries/golang.md b/website/docs/compute/quickstart/client-libraries/golang.md index c1074b5b6..2bf82e680 100755 --- a/website/docs/compute/quickstart/client-libraries/golang.md +++ b/website/docs/compute/quickstart/client-libraries/golang.md @@ -24,7 +24,7 @@ import ( ) func client() *compute.Client { - token, _ := os.LookupEnv("SCC_ENV_TOKEN") + token, _ := os.LookupEnv("SCN_ENV_TOKEN") client, _ := compute.NewClient(compute.LocalConfig(), token) return client diff --git a/website/docs/compute/quickstart/run-compute-locally.md b/website/docs/compute/quickstart/run-compute-locally.md index 569e630af..e23036edc 100755 --- a/website/docs/compute/quickstart/run-compute-locally.md +++ b/website/docs/compute/quickstart/run-compute-locally.md @@ -28,16 +28,16 @@ When you run Compute, it will wait for you to press enter to start a REPL where ✅ DONE: ready to start installation ⏩ START: installing... ▶️ docker-compose up -d -Container suborbital-scc-control-plane-1 Recreate -Container suborbital-scc-control-plane-1 Recreated -Container suborbital-scc-atmo-1 Recreate -Container suborbital-scc-atmo-1 Recreated -Container suborbital-scc-control-plane-1 Starting -Container suborbital-scc-builder-1 Starting -Container suborbital-scc-control-plane-1 Started -Container suborbital-scc-builder-1 Started -Container suborbital-scc-atmo-1 Starting -Container suborbital-scc-atmo-1 Started +Container suborbital-scn-controlplane-1 Recreate +Container suborbital-scn-controlplane-1 Recreated +Container suborbital-scn-atmo-1 Recreate +Container suborbital-scn-atmo-1 Recreated +Container suborbital-scn-controlplane-1 Starting +Container suborbital-scn-builder-1 Starting +Container suborbital-scn-controlplane-1 Started +Container suborbital-scn-builder-1 Started +Container suborbital-scn-atmo-1 Starting +Container suborbital-scn-atmo-1 Started ℹ️ use `docker ps` and `docker-compose logs` to check deployment status PROXY: local tunnel to function editor started From 1af1d145b35ad6b5852fc0d5abc10e3dd5f0380b Mon Sep 17 00:00:00 2001 From: Laura Langdon <48335772+LauraLangdon@users.noreply.github.com> Date: Fri, 9 Sep 2022 09:20:09 -0700 Subject: [PATCH 2/2] fix: add 'scn' to dictionary --- spelling.dic | 3 +++ 1 file changed, 3 insertions(+) diff --git a/spelling.dic b/spelling.dic index 8fed33025..f5207a75c 100644 --- a/spelling.dic +++ b/spelling.dic @@ -390,6 +390,9 @@ scalability scc SCC SCHED +scn +scn +SCN SDK SelectUserWithUUID semconv