Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added abc cli template #361

Merged
merged 6 commits into from
Oct 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
uses: 'abcxyz/pkg/.github/workflows/terraform-lint.yml@main' # ratchet:exclude
with:
directory: 'terraform'
terraform_version: '1.2'
terraform_version: '1.3.6'

yaml_lint:
uses: 'abcxyz/pkg/.github/workflows/yaml-lint.yml@main' # ratchet:exclude
Expand Down
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ JVS consists of the following components:

## Installation

### Via Terraform Module
You can use the provided Terraform module to setup the basic infrastructure
needed for this service. Otherwise you can refer to the provided module to see
how to build your own Terraform from scratch.
Expand Down Expand Up @@ -100,6 +101,26 @@ module "jvs" {
prober_audience = "https://example-api-jvs-cloud-run.run.app"
}
```
### Via [abc CLI](https://github.com/abcxyz/abc#abc)
You can also leverage [abc CLI](https://github.com/abcxyz/abc#abc) to set up the basic infrastructure
needed for this service.
You will need to install [abc CLI](https://github.com/abcxyz/abc#abc)
by following docs [here]https://github.com/abcxyz/abc#installation.

```sh
abc templates render \
-input="<YOUR_PROJECT_ID>" \
-input="jvs_release_version=<JVS_RELEASE_VERSION>" \
-input="jvs_api_domain=<YOUR_JVS_API_DOMAIN>" \
-input="jvs_ui_domain=<YOUR_JVS_UI_DOMAIN>" \
-input="iap_support_email=<YOUR_IAP_SUPPORT_EMAIL>" \
-input="notification_channel_email=<YOUR_NOTIFICATION_CHANNEL_EMAIL>" \
-input="jvs_invoker_members=<YOUR_JVS_INVOKE_MEMBERS>" \
-input="prober_audience=<YOUR_CLOUD_RUN_URL_FOR_JVS_API_SERVICE_OR_APP_ADDRESS>" \
-input="terraform_state_bucket=<YOUR_TERRAFORM_STATE_BUCKET>" \
-input="terraform_state_prefix=<YOUR_TERRAFORM_STATE_PREFIX>" \
github.com/abcxyz/jvs.git//templates/jvs-e2e
```

## External Verifier

Expand Down
2 changes: 1 addition & 1 deletion terraform/modules/jvs-services/cert-rotator.tf
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ resource "google_project_service" "services" {
}

module "cert_rotator_cloud_run" {
source = "git::https://github.com/abcxyz/terraform-modules.git//modules/cloud_run?ref=46d3ffd82d7c3080bc5ec2cc788fe3e21176a8be"
source = "git::https://github.com/abcxyz/terraform-modules.git//modules/cloud_run?ref=580de3cc99dce5f37f7698b14e04fdd1c86ab15a"

project_id = var.project_id

Expand Down
2 changes: 1 addition & 1 deletion terraform/modules/jvs-services/jvs-api.tf
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
# limitations under the License.

module "api_cloud_run" {
source = "git::https://github.com/abcxyz/terraform-modules.git//modules/cloud_run?ref=46d3ffd82d7c3080bc5ec2cc788fe3e21176a8be"
source = "git::https://github.com/abcxyz/terraform-modules.git//modules/cloud_run?ref=580de3cc99dce5f37f7698b14e04fdd1c86ab15a"

project_id = var.project_id

Expand Down
2 changes: 1 addition & 1 deletion terraform/modules/jvs-services/jvs-ui.tf
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
# limitations under the License.

module "ui_cloud_run" {
source = "git::https://github.com/abcxyz/terraform-modules.git//modules/cloud_run?ref=46d3ffd82d7c3080bc5ec2cc788fe3e21176a8be"
source = "git::https://github.com/abcxyz/terraform-modules.git//modules/cloud_run?ref=580de3cc99dce5f37f7698b14e04fdd1c86ab15a"

project_id = var.project_id

Expand Down
2 changes: 1 addition & 1 deletion terraform/modules/jvs-services/public-key.tf
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
# limitations under the License.

module "public_key_cloud_run" {
source = "git::https://github.com/abcxyz/terraform-modules.git//modules/cloud_run?ref=46d3ffd82d7c3080bc5ec2cc788fe3e21176a8be"
source = "git::https://github.com/abcxyz/terraform-modules.git//modules/cloud_run?ref=580de3cc99dce5f37f7698b14e04fdd1c86ab15a"

project_id = var.project_id

Expand Down