From b83c776c0f2f2579674edf9550c3d7fe882d1e08 Mon Sep 17 00:00:00 2001 From: Volodymyr Zotov Date: Fri, 8 Dec 2023 16:19:09 -0600 Subject: [PATCH] Add 'Use with 1Password CLI' section in the documentation 'Use with 1Password CLI' section contains the information about retries and how to authenticate CLI with service account or user account --- docs/index.md | 13 +++++++------ templates/index.md.tmpl | 13 +++++++------ 2 files changed, 14 insertions(+), 12 deletions(-) diff --git a/docs/index.md b/docs/index.md index 15112557..ceb9a15a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -15,20 +15,21 @@ and [1Password CLI](https://developer.1password.com/docs/cli). You must install [1Password CLI](https://developer.1password.com/docs/cli) on the machine running Terraform to use it. Refer to the [Terraform documentation](https://developer.hashicorp.com/terraform/cloud-docs/run/install-software#only-install-standalone-binaries) to learn how to install 1Password CLI on Terraform Cloud. -## Authenticate CLI with service account +## Use with 1Password CLI -To authenticate CLI with service account, set `service_account_token` in the provider configuration. - -Retry mechanism is implemented when using provider with service account. Each retry fast forwards to the [service account rate limit](https://developer.1password.com/docs/service-accounts/rate-limits/). +Retry mechanism is implemented when using the provider with 1Password CLI. The reason for having a retry mechanism is that 1Password doesn't allow parallel modification on the items located in the same vault. +Note that each retry fast forwards to the [service account rate limit](https://developer.1password.com/docs/service-accounts/rate-limits/) if use with service account. It's recommended to limit the number of parallel resource operations. It can be done by using `-parallelism=n` flag when running `terraform apply`, where `n` is the number of parallel resource operations (the default is `10`). ``` terraform apply `-parallelism=n` ``` -The reason for having a retry mechanism is that 1Password doesn't allow parallel modification on the items located in the same vault. +### Authenticate CLI with service account + +To authenticate CLI with service account, set `service_account_token` in the provider configuration. -## Authenticate the CLI with user account using biometric unlock +### Authenticate the CLI with user account using biometric unlock To authenticate the CLI with user account using biometric unlock: 1. [Turn on the app integration](https://developer.1password.com/docs/cli/app-integration/#step-1-turn-on-the-app-integration) diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl index b4393fde..46fa5c5f 100644 --- a/templates/index.md.tmpl +++ b/templates/index.md.tmpl @@ -15,20 +15,21 @@ and [1Password CLI](https://developer.1password.com/docs/cli). You must install [1Password CLI](https://developer.1password.com/docs/cli) on the machine running Terraform to use it. Refer to the [Terraform documentation](https://developer.hashicorp.com/terraform/cloud-docs/run/install-software#only-install-standalone-binaries) to learn how to install 1Password CLI on Terraform Cloud. -## Authenticate CLI with service account +## Use with 1Password CLI -To authenticate CLI with service account, set `service_account_token` in the provider configuration. - -Retry mechanism is implemented when using provider with service account. Each retry fast forwards to the [service account rate limit](https://developer.1password.com/docs/service-accounts/rate-limits/). +Retry mechanism is implemented when using the provider with 1Password CLI. The reason for having a retry mechanism is that 1Password doesn't allow parallel modification on the items located in the same vault. +Note that each retry fast forwards to the [service account rate limit](https://developer.1password.com/docs/service-accounts/rate-limits/) if use with service account. It's recommended to limit the number of parallel resource operations. It can be done by using `-parallelism=n` flag when running `terraform apply`, where `n` is the number of parallel resource operations (the default is `10`). ``` terraform apply `-parallelism=n` ``` -The reason for having a retry mechanism is that 1Password doesn't allow parallel modification on the items located in the same vault. +### Authenticate CLI with service account + +To authenticate CLI with service account, set `service_account_token` in the provider configuration. -## Authenticate the CLI with user account using biometric unlock +### Authenticate the CLI with user account using biometric unlock To authenticate the CLI with user account using biometric unlock: 1. [Turn on the app integration](https://developer.1password.com/docs/cli/app-integration/#step-1-turn-on-the-app-integration)