2019-03-08 18:47:06 +00:00
|
|
|
---
|
|
|
|
|
title: "Google Cloud"
|
|
|
|
|
date: 2019-03-03T16:39:46+01:00
|
|
|
|
|
draft: false
|
|
|
|
|
slug: gcloud
|
2022-06-16 22:25:42 +00:00
|
|
|
dnsprovider:
|
|
|
|
|
since: "v0.3.0"
|
|
|
|
|
code: "gcloud"
|
|
|
|
|
url: "https://cloud.google.com"
|
2019-03-08 18:47:06 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
|
|
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
|
|
|
|
|
<!-- providers/dns/gcloud/gcloud.toml -->
|
|
|
|
|
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Configuration for [Google Cloud](https://cloud.google.com).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--more-->
|
|
|
|
|
|
|
|
|
|
- Code: `gcloud`
|
2022-06-16 22:25:42 +00:00
|
|
|
- Since: v0.3.0
|
|
|
|
|
|
2019-03-08 18:47:06 +00:00
|
|
|
|
2023-01-18 08:55:46 +00:00
|
|
|
Here is an example bash command using the Google Cloud provider:
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
GCE_PROJECT="gc-project-id" GCE_SERVICE_ACCOUNT_FILE="/path/to/svc/account/file.json" lego \
|
|
|
|
|
--email="abc@email.com" \
|
|
|
|
|
--domains="example.com" \
|
|
|
|
|
--dns="gcloud" \
|
|
|
|
|
--path="${HOME}/.lego" \
|
|
|
|
|
run
|
|
|
|
|
```
|
2019-03-08 18:47:06 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Credentials
|
|
|
|
|
|
|
|
|
|
| Environment Variable Name | Description |
|
|
|
|
|
|-----------------------|-------------|
|
|
|
|
|
| `Application Default Credentials` | [Documentation](https://cloud.google.com/docs/authentication/production#providing_credentials_to_your_application) |
|
2020-01-04 16:18:34 +00:00
|
|
|
| `GCE_PROJECT` | Project name (by default, the project name is auto-detected by using the metadata service) |
|
2019-03-08 18:47:06 +00:00
|
|
|
| `GCE_SERVICE_ACCOUNT` | Account |
|
|
|
|
|
| `GCE_SERVICE_ACCOUNT_FILE` | Account file path |
|
|
|
|
|
|
2019-03-18 16:42:54 +00:00
|
|
|
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
|
2022-06-16 22:25:42 +00:00
|
|
|
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
|
2019-03-18 16:42:54 +00:00
|
|
|
|
2019-03-08 18:47:06 +00:00
|
|
|
|
|
|
|
|
## Additional Configuration
|
|
|
|
|
|
|
|
|
|
| Environment Variable Name | Description |
|
|
|
|
|
|--------------------------------|-------------|
|
2020-09-26 11:29:42 +00:00
|
|
|
| `GCE_ALLOW_PRIVATE_ZONE` | Allows requested domain to be in private DNS zone, works only with a private ACME server (by default: false) |
|
2019-03-08 18:47:06 +00:00
|
|
|
| `GCE_POLLING_INTERVAL` | Time between DNS propagation check |
|
|
|
|
|
| `GCE_PROPAGATION_TIMEOUT` | Maximum waiting time for DNS propagation |
|
|
|
|
|
| `GCE_TTL` | The TTL of the TXT record used for the DNS challenge |
|
2024-01-18 21:30:20 +00:00
|
|
|
| `GCE_ZONE_ID` | Allows to skip the automatic detection of the zone |
|
2019-03-08 18:47:06 +00:00
|
|
|
|
2019-03-18 16:42:54 +00:00
|
|
|
The environment variable names can be suffixed by `_FILE` to reference a file instead of a value.
|
2022-06-16 22:25:42 +00:00
|
|
|
More information [here]({{< ref "dns#configuration-and-credentials" >}}).
|
2019-03-18 16:42:54 +00:00
|
|
|
|
2019-03-08 18:47:06 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## More information
|
|
|
|
|
|
2020-04-19 13:08:06 +00:00
|
|
|
- [API documentation](https://cloud.google.com/dns/api/v1/)
|
2019-03-08 18:47:06 +00:00
|
|
|
- [Go client](https://github.com/googleapis/google-api-go-client)
|
|
|
|
|
|
|
|
|
|
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
|
|
|
|
|
<!-- providers/dns/gcloud/gcloud.toml -->
|
|
|
|
|
<!-- THIS DOCUMENTATION IS AUTO-GENERATED. PLEASE DO NOT EDIT. -->
|
