Update examples README

This commit is contained in:
Seth Vargo 2020-03-31 16:55:25 -04:00
parent 00967eba1d
commit 34f3017a06
No known key found for this signature in database
GPG key ID: C921994F9C27E0FF
2 changed files with 9 additions and 26 deletions

View file

@ -2,40 +2,20 @@
These example workflows use the [setup-gcloud][action] to build and deploy applications to Google Cloud Platform.
These examples are intended to be _examples_. You will likely need to change or
update values to match your setup.
## Workflows
| Workflow | Description |
| ------------------------------- | ------------------------ |
| [Google Kubernetes Engine](gke/)| Deploy a static site to an existing GKE cluster |
| [Cloud Run](cloud-run/) | Deploy a container to Cloud Run (Fully Managed)|
| [Google Compute Enginer](gce/) | Deploy a container to a GCE VM |
| [Google Compute Engine](gce/) | Deploy a container to a GCE VM |
## Before you begin
1. [Create or select a Google Cloud Platform project][project].
1. Make sure that billing is enabled for your Google Cloud project. [Learn how to confirm billing is enabled for your project.][billing]
1. [Create a Service Account][service-account] and download a [JSON key][key].
* Base64 encode your JSON key with the following command:
```
base64 ~/path/to/key/key.json
```
* Add the encoded key to the [repository's secrets][secrets] (⚙ Settings > Secrets), named `GOOGLE_APPLICATION_CREDENTIALS`.
* Add the service account email, `<NAME@PROJECT_ID.iam.gserviceaccount.com`, to the repository's secrets, named `SA_EMAIL`.
## Github Actions Resources
## Github Actions resources
Learn more about [Automating your workflow with Github Actions](https://help.github.com/en/actions/automating-your-workflow-with-github-actions).
<!-- links -->
[action]: https://github.com/GoogleCloudPlatform/github-actions/tree/0c32120a9a2dda7fb9b392e6c3b90fa413b4642e/setup-gcloud
[project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects#creating_a_project
[billing]: https://cloud.google.com/billing/docs/how-to/modify-project
[service-account]: https://cloud.google.com/iam/docs/creating-managing-service-accounts#creating
[key]: https://cloud.google.com/iam/docs/creating-managing-service-account-keys#creating_service_account_keys
[secrets]: https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets
[action]: https://github.com/GoogleCloudPlatform/github-actions/tree/master/setup-gcloud

View file

@ -3,6 +3,9 @@
An example workflow that uses [GitHub Actions][actions] to deploy [a static
website](site/) to an existing [Google Kubernetes Engine][gke] cluster.
This code is intended to be an _example_. You will likely need to change or
update values to match your setup.
## Workflow description
For pushes to the `master` branch, this workflow will: