add documentation for multi-project metrics by astropuffin · Pull Request #213 · GoogleCloudPlatform/k8s-stackdriver

astropuffin · 2018-10-08T21:58:24Z

documentation for #212

which addresses #205

loburm · 2018-12-06T12:10:59Z

@kawych do you have any comments?

kawych · 2018-12-28T09:58:44Z

custom-metrics-stackdriver-adapter/examples/cross-project-metrics/README.md

+1. Grant the default service account for your project access to `roles/monitoring.viewer` in
+   your other project.
+
+1. Create your GKE cluster with a service account, and grant the service account access to 


Suggested change

1. Create your GKE cluster with a service account, and grant the service account access to

1. Create your GKE cluster with a custom service account, and grant the service account access to

kawych · 2018-12-28T09:59:39Z

custom-metrics-stackdriver-adapter/examples/cross-project-metrics/README.md

+   `roles/monitoring.viewer` in your other project
+
+1. (Recommended) Create a service a service account for the stackdriver-adapter, and mount
+   the credentials into the pod. This is the method this example implements.


Suggested change

the credentials into the pod. This is the method this example implements.

the credentials into the pod. This is the method explained in this example.

kawych · 2018-12-28T10:00:33Z

custom-metrics-stackdriver-adapter/examples/cross-project-metrics/README.md

+## Create a service account with credentials
+
+For this example, you will need to create a service account. See [Creating a service account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
+for how to do that.


Suggested change

for how to do that.

for instructions.

kawych · 2018-12-28T10:00:56Z

custom-metrics-stackdriver-adapter/examples/cross-project-metrics/README.md

+for how to do that.
+
+
+Next, you will need to create a key for that services account. See [Creating service account keys](https://cloud.google.com/iam/docs/creating-managing-service-account-keys#iam-service-account-keys-create-console) for how to do that.


Suggested change

Next, you will need to create a key for that services account. See [Creating service account keys](https://cloud.google.com/iam/docs/creating-managing-service-account-keys#iam-service-account-keys-create-console) for how to do that.

Next, you will need to create a key for that services account. See [Creating service account keys](https://cloud.google.com/iam/docs/creating-managing-service-account-keys#iam-service-account-keys-create-console) for instructions.

kawych · 2018-12-28T10:02:00Z

custom-metrics-stackdriver-adapter/examples/cross-project-metrics/README.md

+Next, you will need to create a key for that services account. See [Creating service account keys](https://cloud.google.com/iam/docs/creating-managing-service-account-keys#iam-service-account-keys-create-console) for how to do that.
+
+
+Copy the key to this directory. The filename should be `key.json`


Suggested change

Copy the key to this directory. The filename should be `key.json`

Copy the key to your current directory. The filename should be `key.json`

kawych · 2018-12-28T10:06:23Z

custom-metrics-stackdriver-adapter/examples/cross-project-metrics/README.md

+Copy the key to this directory. The filename should be `key.json`
+
+
+Add `roles/monitoring.viewer` to your service account in all projects that you want it to grab metrics from.


Maybe also add a link? https://cloud.google.com/iam/docs/granting-changing-revoking-access

kawych · 2018-12-28T10:09:54Z

custom-metrics-stackdriver-adapter/examples/cross-project-metrics/README.md

+Run the following command:
+
+```
+kubectl apply -f modified-adapter.yml


Can you add a link using raw github content instead of assuming that user has cloned this repo? Something like: https://raw.githubusercontent.com/GoogleCloudPlatform/k8s-stackdriver/master/custom-metrics-stackdriver-adapter/examples/cross-project-metrics/adapter.yaml

kawych · 2018-12-28T10:12:42Z

custom-metrics-stackdriver-adapter/examples/cross-project-metrics/README.md

+There are several places where cross project autoscaling can get stuck, so when troubleshooting
+make sure to check them one by one.
+
+1. Check that your service account has the right permissions. It needs `roles/monitoring.viewer`


Suggested change

1. Check that your service account has the right permissions. It needs `roles/monitoring.viewer`

1. Check that your service account has the right permissions on the IAM page of **your other project**. It needs `roles/monitoring.viewer`

kawych · 2018-12-28T10:29:47Z

custom-metrics-stackdriver-adapter/examples/cross-project-metrics/README.md

+curl http://localhost:8001/apis/custom.metrics.k8s.io/v1beta1/namespaces/<namespace-name>/pods/*/<metric-name>
+```
+
+This should return a MetricValueList object. If you get a 404, the metric timeseries is not available from


There are two different cases here:

You get 404 - this usually means that the metric descriptor for <metric-name> doesn't exist for specified project (e.g. or project is incorrect).

You get [] (empty list) - this means that the metric is correct, but no timeseries were found. This may also be caused by several things, for example:

<namespace-name> is incorrect

<metric-name> wasn't exporter recently, e.g. deployment-to-be-scaled.yml was not deployed

Also, note that this url will look for metric for your current project. To check for metrics from different project, add suffix "?labelSelector=resource.labels.project_id=<my-other-project>"

kawych · 2018-12-28T10:32:42Z

custom-metrics-stackdriver-adapter/examples/cross-project-metrics/README.md

+```
+And check the available metrics
+```
+curl http://localhost:8001/apis/custom.metrics.k8s.io/v1beta1/


Unfortunately this won't work. This returns metrics from your current project, while the requested metric can be specified only for the other project. It may still make sense to check that for predefined metrics (non-custom metrics) that should exist for all projects, such as pubsub metrics used here.

kawych · 2018-12-28T10:35:37Z

custom-metrics-stackdriver-adapter/examples/cross-project-metrics/modified-adapter.yml

@@ -0,0 +1,51 @@
+apiVersion: extensions/v1beta1


It would be useful to include a comment at the top to explain that it is modified by mounting service account credentials.

kawych

Thanks for this! Added few commits, after these changes I think we're good to go

kawych · 2018-12-28T10:39:48Z

Sorry for delay with this review. FYI, I'm starting the release of this feature.

sjoeboo · 2019-02-15T17:34:49Z

Any updates on releasing this feature?

kawych · 2019-02-20T08:43:18Z

I've started the release, but it got stuck in review, sorry for delay.

add documentation

c0dd551

googlebot added the cla: yes label Oct 8, 2018

astropuffin changed the title ~~add documentation~~ add documentation for multi-project metrics Oct 8, 2018

astropuffin mentioned this pull request Oct 8, 2018

add support for other projects for external metrics #212

Merged

kawych self-assigned this Oct 12, 2018

kawych self-requested a review October 12, 2018 09:30

kawych reviewed Dec 28, 2018

View reviewed changes

kawych requested changes Dec 28, 2018

View reviewed changes

juli4n added the custom-metrics-stackdriver-adapter Issues for custom-metrics-stackdriver-adapter label Aug 4, 2025

	1. Create your GKE cluster with a service account, and grant the service account access to
	1. Create your GKE cluster with a custom service account, and grant the service account access to

	the credentials into the pod. This is the method this example implements.
	the credentials into the pod. This is the method explained in this example.

		for how to do that.


		Next, you will need to create a key for that services account. See [Creating service account keys](https://cloud.google.com/iam/docs/creating-managing-service-account-keys#iam-service-account-keys-create-console) for how to do that.

		Next, you will need to create a key for that services account. See [Creating service account keys](https://cloud.google.com/iam/docs/creating-managing-service-account-keys#iam-service-account-keys-create-console) for how to do that.


		Copy the key to this directory. The filename should be `key.json`

	Copy the key to this directory. The filename should be `key.json`
	Copy the key to your current directory. The filename should be `key.json`

		Copy the key to this directory. The filename should be `key.json`


		Add `roles/monitoring.viewer` to your service account in all projects that you want it to grab metrics from.

	1. Check that your service account has the right permissions. It needs `roles/monitoring.viewer`
	1. Check that your service account has the right permissions on the IAM page of your other project. It needs `roles/monitoring.viewer`

Conversation

astropuffin commented Oct 8, 2018

Uh oh!

loburm commented Dec 6, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kawych Dec 28, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kawych Dec 28, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kawych left a comment

Choose a reason for hiding this comment

Uh oh!

kawych commented Dec 28, 2018

Uh oh!

sjoeboo commented Feb 15, 2019

Uh oh!

kawych commented Feb 20, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

kawych Dec 28, 2018 •

edited

Loading

kawych Dec 28, 2018 •

edited

Loading