Update Compute cloud deployment docs #167
Conversation
LauraLangdon
added
the
documentation
* Add local deployment docs * Restructure to be 'with Minikube' * Adopt lovely feedback * add words to dictionary * add more words to dictionary * Update website/docs/compute/local-deployment/minikube.md Co-authored-by: Laura Langdon <[email protected]> * Update website/docs/compute/local-deployment/minikube.md Co-authored-by: Laura Langdon <[email protected]> * Update website/docs/compute/local-deployment/minikube.md Co-authored-by: Laura Langdon <[email protected]> * Update website/docs/compute/local-deployment/minikube.md Co-authored-by: Laura Langdon <[email protected]> * Update website/docs/compute/local-deployment/minikube.md Co-authored-by: Laura Langdon <[email protected]> * Update website/docs/compute/local-deployment/minikube.md Co-authored-by: Laura Langdon <[email protected]> * Apply feedback * Rename subcategory to Other Deployments * Lowercase minikube * Remove trailing comma Co-authored-by: Laura Langdon <[email protected]> Co-authored-by: Laura Langdon <[email protected]>
LauraLangdon
requested review from
ospencer,
callahad,
flaki and
hola-soy-milk
| ### Amazon S3 | ||
|
|
||
| You will need to also supply the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_SESSION_TOKEN` and `AWS_REGION` environment variables to both the control plane and the builder. See the [AWS authentication documentation](https://docs.aws.amazon.com/sdk-for-go/api/aws/session/) for details. It is also possible to store the configuration as a Kubernetes secret, similar to the Google Cloud Storage configuration. | ||
| You will need to supply the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_SESSION_TOKEN` and `AWS_REGION` environment variables to the API for both the control plane and the builder. See the [AWS authentication documentation](https://docs.aws.amazon.com/sdk-for-php/v3/developer-guide/guide_credentials_environment.html) for details. It is also possible to store the configuration as a Kubernetes secret, similar to the Google Cloud Storage configuration. |
There was a problem hiding this comment.
We should specify that they need to be added to the yaml file, and also show them in the example. I also wonder if we want to keep this bit about the Kubernetes secret. Maybe we have it link to the other tab?
There was a problem hiding this comment.
We do specify the different yaml files in the next paragraph down:
For Kubernetes deployments, this is done in
.suborbital/scc-controlplane-deployment.yamlunder thecontrolplaneandbuildercontainers sections, and for local docker-compose deployments, this is done indocker-compose.yamlunder thescc-control-planeandscc-builderservices.
and also show them in the example
Do you mean show the file name in the yaml codeblock? I considered that but decided against it since there are two candidates for the file name depending on whether a deployment is on Kubernetes or local.
I also wonder if we want to keep this bit about the Kubernetes secret. Maybe we have it link to the other tab?
I'll add a link to the GCS tab!
| kubectl exec -n suborbital -it scc-controlplane-deployment-<REST OF POD CODENAME> -- bash | ||
| ``` | ||
|
|
||
| Would you look at that, we’re inside our cluster now! |
There was a problem hiding this comment.
This feels a bit off of our usual tone in the docs.
There was a problem hiding this comment.
This isn't "mine", as such; it was merged in PR #158 (I think it's showing as a change here because I had a stub for it before the other was merged and had to swap out the stub for the merged one. Probably there's a better way to do that, my bad).
I do like an aggressively upbeat and fun tone, though. 😊 If you'd rather we stay more neutral than cheerleader, I can change it ofc!
Co-authored-by: Oscar Spencer <[email protected]>
I don't think so; the conflict was with this change. |
Per Issue #166: