Documentation bugs in custom-metrics-stackdriver-adapter README

[asfaltboy]

I'm just starting to follow the Custom Metrics - Stackdriver Adapter installation instructions (got here from the GKE doc on 'Optimize Pod autoscaling based on metrics'), and already noticing a few odd issues with the docs:

• Recommendation to add scopes is likely irrelevant given the content of this doc - we probably want to update this section, link to this doc about access scopes and perhaps replace the oauth instructions with a mention of configuring IAM for the service account associated with the cluster (we can link to the latter section fo the same doc).

  For context, the document begins with:

  Access scopes are the legacy method of granting permissions for your nodes, and for workloads running on your nodes if the workloads use application default credentials (ADC). Access scopes define the OAuth scopes used in API calls from client libraries or the gcloud CLI.

• The section on 'Workload identity' is missing words, here's an excerpt:

  If you use Workload Identity in your cluster, additional steps are necessary. In the commands below, use your Project ID as and Google Service Account as .

Given the warning in the root of the repo, are contributions welcome? Also, is it even recommended to follow this guide, or is there a way to install the adapter automatically in GKE?

[PaulRudin]

... in particular in the section about workload identity. Presumably you need to create the GCP service account - but this isn't made explicit.

[CatherineF-dev]

Given the warning in the root of the repo, are contributions welcome?

Yes, contributions are welcomed @asfaltboy

You can create a PR, and we will help review.

[CatherineF-dev]

/label custom-metrics-stackdriver-adapter