chore: align service token env vars with pscale cli #103
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mdlayher
previously approved these changes
Jan 23, 2025
Deprecate `PLANETSCALE_SERVICE_TOKEN_NAME` in favor of `PLANETSCALE_SERVICE_TOKEN_ID` to match the pscale CLI conventions. - Replace environment variable for better CLI alignment - Maintain backwards compatibility with warning messages - Update service-token limitation documentation Reference: https://github.com/planetscale/cli/blob/main/README.md?plain=1#L97-L98
joemiller
force-pushed
the
joem/align-token-env-vars
branch
from
6aebefd to
7998965
Compare
mdlayher
approved these changes
Jan 23, 2025
| @@ -7,7 +7,7 @@ description: |- | |||
| access token credentials, configured or stored in the environment variable PLANETSCALE_ACCESS_TOKENservice token credentials, configured or stored in the environment variables PLANETSCALE_SERVICE_TOKEN_NAME and PLANETSCALE_SERVICE_TOKEN | |||
| Note that the provider is not production ready and only for early testing at this time. | |||
| Known limitations: | |||
| Support for deployments, deploy queues, deploy requests and reverts is not implemented at this time. If you have a use case for it, please let us know in the repository issues.Service tokens don't immediately have read/write access on the resources they create. For now, access must be granted via the UI or via the CLI (pscale service-token add-access) | |||
| Support for deployments, deploy queues, deploy requests and reverts is not implemented at this time. If you have a use case for it, please let us know in the repository issues.When using service tokens (recommended), ensure the token has the create_databases organization-level permission. This allows terraform to create new databases and automatically grants the token all other permissions on the databases created by the token. | |||
There was a problem hiding this comment.
Suggested change
| Support for deployments, deploy queues, deploy requests and reverts is not implemented at this time. If you have a use case for it, please let us know in the repository issues.When using service tokens (recommended), ensure the token has the create_databases organization-level permission. This allows terraform to create new databases and automatically grants the token all other permissions on the databases created by the token. | |
| Support for deployments, deploy queues, deploy requests and reverts is not implemented at this time. If you have a use case for it, please let us know in the repository issues. When using service tokens (recommended), ensure the token has the create_databases organization-level permission. This allows terraform to create new databases and automatically grants the token all other permissions on the databases created by the token. |
There was a problem hiding this comment.
@mdlayher I know this looks weird, and it puzzled me for several minutes. This is generated by tfplugindocs. It is in the front-matter of the yaml and so I presume it is fine, because the actual rendered documentation a few lines lower in this file has the proper formatting and this is what is visbile on the TF registry page here: https://registry.terraform.io/providers/planetscale/planetscale/latest/docs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Deprecate
PLANETSCALE_SERVICE_TOKEN_NAMEin favor ofPLANETSCALE_SERVICE_TOKEN_IDto match the pscale CLI conventions.Reference: https://github.com/planetscale/cli/blob/main/README.md?plain=1#L97-L98