docs: add GCP Cloud Spanner scaler - #1786
Conversation
✅ Deploy Preview for keda ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Thank you for your contribution! 🙏 We will review your PR as soon as possible.
Learn more about:
|
c818f0b to
5a93144
Compare
Adds documentation for the new gcp-spanner trigger introduced in kedacore/keda#7844. Covers: - All trigger parameters with defaults and descriptions - Three authentication methods: inline JSON, env file path, Workload Identity - Three ScaledObject examples (inline creds, TriggerAuthentication, pod identity) Signed-off-by: Petr Petrenko | INPD <petr.petrenko@rakuten.com>
5a93144 to
9704889
Compare
|
@wozniakjan @rickbrouwer the main PR has been merged, could you take a look at the docs PR when you have a moment? Branch is now up to date. Thanks! |
| While `currentValue ≤ activationValue` the scaler is considered inactive and | ||
| the deployment is held at 0 replicas. | ||
| Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). |
There was a problem hiding this comment.
Take a look at how this is described for other scalers. Because I think this information is redundant. It is also not entirely correct, because it is not kept at 0 if you do not have a minReplicaCount of 0.
There was a problem hiding this comment.
Fixed, removed the redundant description.
| stringData: | ||
| creds.json: | | ||
| { "type": "service_account", ... } |
There was a problem hiding this comment.
Could you compare your documentation against the other GCP documentation to draw the line more closely?
There was a problem hiding this comment.
Fixed, rewrote the entire doc to match gcp-storage style closely.
| query: "SELECT COUNT(*) FROM jobs WHERE status = 'pending'" # Required | ||
| targetValue: "5" # Optional - default: 5 | ||
| activationValue: "0" # Optional - default: 0 | ||
| credentialsFromEnv: GOOGLE_APPLICATION_CREDENTIALS_JSON # Required* |
There was a problem hiding this comment.
Required*
I believe the other GCP scalers handle this differently regarding documentation. Please verify this there so we maintain consistency.
There was a problem hiding this comment.
Fixed, aligned with the gcp-storage pattern.
- Remove redundant scale-to-zero description (not always accurate) - Simplify parameter list format to match gcp-storage pattern - Align Authentication Parameters section with other GCP scalers - Add all three authentication examples (env, TriggerAuthentication, GCP Identity) Signed-off-by: Petr Petrenko | INPD <petr.petrenko@rakuten.com>
Signed-off-by: Petr Petrenko | INPD <petr.petrenko@rakuten.com>
2 participants
Description
Adds documentation for the new
gcp-spannertrigger introduced in kedacore/keda#7844.Changes
content/docs/2.21/scalers/gcp-spanner.md— new scaler documentation pageDocumentation covers
0, not an errorcredentialsFromEnvcredentialsFromEnvFileTriggerAuthenticationwithpodIdentity.provider: gcpScaledObjectexamples (inline credentials,TriggerAuthenticationwith Secret, Workload Identity)Related