chore: Update cloud docs reserved variables and encryption documentat…

…ion (meltano#7439) * updating encryption and reserved var docs * update * Apply suggestions from code review Co-authored-by: Edgar R. M. <edgar@meltano.com> --------- Co-authored-by: Edgar R. M. <edgar@meltano.com>
BuzzCutNorman · Mar 28, 2023 · 4b772f7 · 4b772f7
1 parent 5dd95a1
commit 4b772f7
Show file tree

Hide file tree

Showing 13 changed files with 76 additions and 15 deletions.
diff --git a/docs/src/_cloud/api_reference.md b/docs/src/_cloud/api_reference.md
@@ -7,7 +7,7 @@ hidden: true
 
 <div class="notification is-info">
   <p><strong>Meltano Cloud is currently in Beta.</strong></p>
-  <p>While in Beta, functionality is not guaranteed and subject to change. <br> If you're interesting in using Meltano Cloud please join our <a href="https://meltano.com/cloud/">waitlist</a>.</p>
+  <p>While in Beta, functionality is not guaranteed and subject to change. <br> If you're interested in using Meltano Cloud please join our <a href="https://meltano.com/cloud/">waitlist</a>.</p>
 </div>
 
 API usage and examples for features of Meltano Cloud.

diff --git a/docs/src/_cloud/concepts.md b/docs/src/_cloud/concepts.md
@@ -7,7 +7,7 @@ weight: 1
 
 <div class="notification is-info">
   <p><strong>Meltano Cloud is currently in Beta.</strong></p>
-  <p>While in Beta, functionality is not guaranteed and subject to change. <br> If you're interesting in using Meltano Cloud please join our <a href="https://meltano.com/cloud/">waitlist</a>.</p>
+  <p>While in Beta, functionality is not guaranteed and subject to change. <br> If you're interested in using Meltano Cloud please join our <a href="https://meltano.com/cloud/">waitlist</a>.</p>
 </div>
 
 ## Meltano Cloud Users

diff --git a/docs/src/_cloud/encrypting_secrets.md b/docs/src/_cloud/encrypting_secrets.md
@@ -7,21 +7,38 @@ weight: 8
 
 <div class="notification is-info">
   <p><strong>Meltano Cloud is currently in Beta.</strong></p>
-  <p>While in Beta, functionality is not guaranteed and subject to change. <br> If you're interesting in using Meltano Cloud please join our <a href="https://meltano.com/cloud/">waitlist</a>.</p>
+  <p>While in Beta, functionality is not guaranteed and subject to change. <br> If you're interested in using Meltano Cloud please join our <a href="https://meltano.com/cloud/">waitlist</a>.</p>
 </div>
 
 This document covers information on encrypting secrets in your Meltano `secrets.yml` file.
 
 ## Components for Encryption
 
-### Public Key
+### Encryption Method
+
+Use the `meltano cloud config env set <SECRET_NAME>` CLI command to set an environment variable secret.
+
+This will set secrets via the `.env` file at runtime for a job or schedule.
+
+You can list and delete secrets configured as well.
+
+```
+meltano cloud config env list
+meltano cloud config env delete <SECRET_NAME>
+```
+
+Secrets cannot be decrypted after they are set. If you need to change a secret, you can set the secret again.
+
+### Alpha Phase Encryption Method
+> The following method will be deprecated in Beta
+#### Public Key
 
 During the on-boarding process, Meltano will provide you with the Public Key of your public/private encryption key pair.
 For details on the encryption algorithms and other security related information, refer to the [Security page](/security).
 
 Save your public key somewhere for use during encryption.
 
-### Utility kms-ext
+#### Utility kms-ext
 
 We have a utility extension for encrypting your secrets:
 https://github.com/meltano/kms-ext
@@ -39,7 +56,7 @@ Once installed, you should be able to run `kms --help` to see usage, options, an
 > If you need to change or confirm your values, you will need to re-encrypt your .env file.
 > Each time encryption is performed, all contents in the .env file will update.
 
-### Example
+#### Example
 
 For this example, the following statements are true:
 

diff --git a/docs/src/_cloud/index.md b/docs/src/_cloud/index.md
@@ -8,7 +8,7 @@ toc: false
 
 <div class="notification is-info">
   <p><strong>Meltano Cloud is currently in Beta.</strong></p>
-  <p>While in Beta, functionality is not guaranteed and subject to change. <br> If you're interesting in using Meltano Cloud please join our <a href="https://meltano.com/cloud/">waitlist</a>.</p>
+  <p>While in Beta, functionality is not guaranteed and subject to change. <br> If you're interested in using Meltano Cloud please join our <a href="https://meltano.com/cloud/">waitlist</a>.</p>
 </div>
 
 ## Index

diff --git a/docs/src/_cloud/known_issues.md b/docs/src/_cloud/known_issues.md
@@ -7,7 +7,7 @@ hidden: true
 
 <div class="notification is-info">
   <p><strong>Meltano Cloud is currently in Beta.</strong></p>
-  <p>While in Beta, functionality is not guaranteed and subject to change. <br> If you're interesting in using Meltano Cloud please join our <a href="https://meltano.com/cloud/">waitlist</a>.</p>
+  <p>While in Beta, functionality is not guaranteed and subject to change. <br> If you're interested in using Meltano Cloud please join our <a href="https://meltano.com/cloud/">waitlist</a>.</p>
 </div>
 
 ## Limitations during Alpha

diff --git a/docs/src/_cloud/onboarding.md b/docs/src/_cloud/onboarding.md
@@ -7,7 +7,7 @@ weight: 2
 
 <div class="notification is-info">
   <p><strong>Meltano Cloud is currently in Beta.</strong></p>
-  <p>While in Beta, functionality is not guaranteed and subject to change. <br> If you're interesting in using Meltano Cloud please join our <a href="https://meltano.com/cloud/">waitlist</a>.</p>
+  <p>While in Beta, functionality is not guaranteed and subject to change. <br> If you're interested in using Meltano Cloud please join our <a href="https://meltano.com/cloud/">waitlist</a>.</p>
 </div>
 
 ## Prereqs

diff --git a/docs/src/_cloud/platform.md b/docs/src/_cloud/platform.md
@@ -6,7 +6,7 @@ weight: 3
 
 <div class="notification is-info">
   <p><strong>Meltano Cloud is currently in Beta.</strong></p>
-  <p>While in Beta, functionality is not guaranteed and subject to change. <br> If you're interesting in using Meltano Cloud please join our <a href="https://meltano.com/cloud/">waitlist</a>.</p>
+  <p>While in Beta, functionality is not guaranteed and subject to change. <br> If you're interested in using Meltano Cloud please join our <a href="https://meltano.com/cloud/">waitlist</a>.</p>
 </div>
 
 ## Cloud Platform

diff --git a/docs/src/_cloud/reserved_variables.md b/docs/src/_cloud/reserved_variables.md
@@ -0,0 +1,44 @@
+---
+title: "Reserved Variables"
+description: Reserved variables for use in Meltano Cloud
+layout: doc
+weight: 2
+---
+
+<div class="notification is-info">
+  <p><strong>Meltano Cloud is currently in Beta.</strong></p>
+  <p>While in Beta, functionality is not guaranteed and subject to change. <br> If you're interested in using Meltano Cloud please join our <a href="https://meltano.com/cloud/">waitlist</a>.</p>
+</div>
+
+# Reserved Variables
+
+There are specific environment variables that are reserved for certain use-cases.
+
+## SSH Private Keys for Private Git Repository Package Access
+
+`GIT_SSH_PRIVATE_KEY` is a reserved variable that should be set if you have private repository packages.
+
+> The following instruction and example is secrets encryption for Alpha which will be deprecated in Beta.
+> Current encryption instructions can be found in our [Encrypting Secrets guide](https://github.com/meltano/cloud-docs/blob/main/docs/encrypting_secrets.md#components-for-encryption).
+
+To encrypt, set the ssh private key env variable into your `.env` file as-is in the private key file with single quotes
+around them.
+
+Example `.env` file to be encrypted:
+```
+GIT_SSH_PRIVATE_KEY='-----BEGIN OPENSSH PRIVATE KEY-----
+therearelotsofprivatekeymaterialhere
+onvariouslineslikethis
+wecanjustcopypasteasitappearsinthefile
+andusesinglequotesaroundthewholething
+-----END OPENSSH PRIVATE KEY-----'
+SOME_OTHER_SECRET=1234asdf
+```
+
+Then continue with encryption using the [kms-ext](https://github.com/meltano/kms-ext) utility.
+
+## Job or Schedule Run Notifications via Webhook
+
+`MELTANO_CLOUD_WEBHOOK_URL` can be set to receive notifications on success or fail of a job or schedule run.
+
+Currently only one webhook URL can be configured.
diff --git a/docs/src/_cloud/sandbox_environments.md b/docs/src/_cloud/sandbox_environments.md
@@ -5,7 +5,7 @@ hidden: true
 ---
 <div class="notification is-info">
   <p><strong>Meltano Cloud is currently in Beta.</strong></p>
-  <p>While in Beta, functionality is not guaranteed and subject to change. <br> If you're interesting in using Meltano Cloud please join our <a href="https://meltano.com/cloud/">waitlist</a>.</p>
+  <p>While in Beta, functionality is not guaranteed and subject to change. <br> If you're interested in using Meltano Cloud please join our <a href="https://meltano.com/cloud/">waitlist</a>.</p>
 </div>
 
 ## Creating a Sandbox Environment for Meltano Cloud

diff --git a/docs/src/_cloud/security-policy.md b/docs/src/_cloud/security-policy.md
@@ -5,7 +5,7 @@ hidden: true
 
 <div class="notification is-info">
   <p><strong>Meltano Cloud is currently in Beta.</strong></p>
-  <p>While in Beta, functionality is not guaranteed and subject to change. <br> If you're interesting in using Meltano Cloud please join our <a href="https://meltano.com/cloud/">waitlist</a>.</p>
+  <p>While in Beta, functionality is not guaranteed and subject to change. <br> If you're interested in using Meltano Cloud please join our <a href="https://meltano.com/cloud/">waitlist</a>.</p>
 </div>
 
 Todo
diff --git a/docs/src/_cloud/security.md b/docs/src/_cloud/security.md
@@ -6,7 +6,7 @@ weight: 4
 ---
 <div class="notification is-info">
   <p><strong>Meltano Cloud is currently in Beta.</strong></p>
-  <p>While in Beta, functionality is not guaranteed and subject to change. <br> If you're interesting in using Meltano Cloud please join our <a href="https://meltano.com/cloud/">waitlist</a>.</p>
+  <p>While in Beta, functionality is not guaranteed and subject to change. <br> If you're interested in using Meltano Cloud please join our <a href="https://meltano.com/cloud/">waitlist</a>.</p>
 </div>
 
 ## Security Whitepaper

diff --git a/docs/src/_cloud/sla.md b/docs/src/_cloud/sla.md
@@ -4,7 +4,7 @@ hidden: true
 ---
 <div class="notification is-info">
   <p><strong>Meltano Cloud is currently in Beta.</strong></p>
-  <p>While in Beta, functionality is not guaranteed and subject to change. <br> If you're interesting in using Meltano Cloud please join our <a href="https://meltano.com/cloud/">waitlist</a>.</p>
+  <p>While in Beta, functionality is not guaranteed and subject to change. <br> If you're interested in using Meltano Cloud please join our <a href="https://meltano.com/cloud/">waitlist</a>.</p>
 </div>
 
 ## Meltano Cloud Service Level Agreement (SLA)

diff --git a/docs/src/_cloud/support.md b/docs/src/_cloud/support.md
@@ -5,7 +5,7 @@ hidden: true
 
 <div class="notification is-info">
   <p><strong>Meltano Cloud is currently in Beta.</strong></p>
-  <p>While in Beta, functionality is not guaranteed and subject to change. <br> If you're interesting in using Meltano Cloud please join our <a href="https://meltano.com/cloud/">waitlist</a>.</p>
+  <p>While in Beta, functionality is not guaranteed and subject to change. <br> If you're interested in using Meltano Cloud please join our <a href="https://meltano.com/cloud/">waitlist</a>.</p>
 </div>
 
 ## Meltano Cloud Technical Support