diff --git a/docs/how-to/authentication-mechanism-troubleshooting.md b/docs/how-to/authentication-mechanism-troubleshooting.md index 5c3cd527ed..7db3645886 100644 --- a/docs/how-to/authentication-mechanism-troubleshooting.md +++ b/docs/how-to/authentication-mechanism-troubleshooting.md @@ -143,15 +143,14 @@ kubectl describe cloudauditlogssource test -n default Kubernetes Service Account `controller` in namespace `events-system`. - If you are using Kubernetes Secret for the Control Plane, refer [here](../install/authentication-mechanisms-gcp.md/#kubernetes-secrets) to - check the Kubernetes Secret `google-cloud-key` in namespace - `events-system`. + check the Kubernetes Secret `google-cloud-key` in namespace `events-system`. **_Note:_** For Kubernetes Secret, if the JSON private key no longer exists under your Google Cloud Service Account `events-controller-gsa`. Then, even the Google Cloud Service Account `events-controller-gsa` has all required permissions, and the corresponding Kubernetes Secret `google-cloud-key` is in -namespace `events-system`, you still get permission related error. To such -case, you have to re-download the JSON private key and re-create the Kubernetes +namespace `events-system`, you still get permission related error. To such case, +you have to re-download the JSON private key and re-create the Kubernetes Secret, refer [here](../install/authentication-mechanisms-gcp.md/#option-2-kubernetes-secrets) for instructions. diff --git a/docs/how-to/broker-priority.md b/docs/how-to/broker-priority.md index c70adeadc4..8b48a2029c 100644 --- a/docs/how-to/broker-priority.md +++ b/docs/how-to/broker-priority.md @@ -3,8 +3,8 @@ ## Background The data plane components of `GCP-broker` are running on Kubernetes clusters in -`events-system` namespace. Their resource consumption depends on the number -of cluster nodes and number of pods running in total. +`events-system` namespace. Their resource consumption depends on the number of +cluster nodes and number of pods running in total. As existing components use more resources and as we add more new components, more cluster and node resources are required to run Kubernetes. This diff --git a/docs/how-to/cloud-trace.md b/docs/how-to/cloud-trace.md index d32c9e41de..52698b90df 100644 --- a/docs/how-to/cloud-trace.md +++ b/docs/how-to/cloud-trace.md @@ -15,8 +15,8 @@ to grant dataplane service accounts `roles/cloudtrace.agent`. ## Enable Tracing in the `config-tracing` ConfigMap -Edit the `config-tracing` ConfigMap under the `events-system` namespace in -Cloud Console or with the following `kubectl` command: +Edit the `config-tracing` ConfigMap under the `events-system` namespace in Cloud +Console or with the following `kubectl` command: ```shell kubectl edit configmap -n events-system config-tracing diff --git a/docs/how-to/metrics.md b/docs/how-to/metrics.md index 7ce978fcb8..0f9f0f8cd5 100644 --- a/docs/how-to/metrics.md +++ b/docs/how-to/metrics.md @@ -36,8 +36,8 @@ gcloud projects add-iam-policy-binding $PROJECT_ID \ ## Enable Metrics in the `config-observability` ConfigMap -Edit the `config-observability` ConfigMap under the `events-system` namespace -in Cloud Console or with the following `kubectl` command: +Edit the `config-observability` ConfigMap under the `events-system` namespace in +Cloud Console or with the following `kubectl` command: ```shell kubectl edit configmap -n events-system config-observability diff --git a/docs/install/install-broker-with-pubsub-channel.md b/docs/install/install-broker-with-pubsub-channel.md index e4b8ff8760..b18670461e 100644 --- a/docs/install/install-broker-with-pubsub-channel.md +++ b/docs/install/install-broker-with-pubsub-channel.md @@ -15,8 +15,8 @@ Channel. ## Deployment -1. Verify the configmap `config-br-default-channel` is in the - `events-system` namespace. +1. Verify the configmap `config-br-default-channel` is in the `events-system` + namespace. ```shell kubectl get configmap config-br-default-channel -n events-system diff --git a/docs/install/install-gcp-broker.md b/docs/install/install-gcp-broker.md index 1ba65a4154..bfd12f69fe 100644 --- a/docs/install/install-gcp-broker.md +++ b/docs/install/install-gcp-broker.md @@ -214,11 +214,11 @@ All GCP Brokers share the following data plane components: [#832](https://github.com/google/knative-gcp/issues/832). In this case you need to delete the pull subscription manually and wait for it to be recreated by the controller. - - Compare `/var/run/events-system/broker/targets` file in the fanout pod - with the contents in `config-targets` configmap in `events-system` - namespace. If they are not the same, it's likely that the configmap volume - in the pod is not updated with the latest information. Delete the pod and - wait for it to be recreated. Meanwhile file a bug. + - Compare `/var/run/events-system/broker/targets` file in the fanout pod with + the contents in `config-targets` configmap in `events-system` namespace. If + they are not the same, it's likely that the configmap volume in the pod is + not updated with the latest information. Delete the pod and wait for it to + be recreated. Meanwhile file a bug. 1. Events are not retried after delivery failures. - Check the fanout pod logs to see if it sends failed events to the retry topic. @@ -229,11 +229,11 @@ All GCP Brokers share the following data plane components: [#832](https://github.com/google/knative-gcp/issues/832). In this case you need to delete the pull subscription manually and wait for it to be recreated by the controller. - - Compare `/var/run/events-system/broker/targets` file in the retry pod - with the contents in `config-targets` configmap in `events-system` - namespace. If they are not the same, it's likely that the configmap volume - in the pod is not updated with the latest information. Delete the pod and - wait for it to be recreated. Meanwhile file a bug. + - Compare `/var/run/events-system/broker/targets` file in the retry pod with + the contents in `config-targets` configmap in `events-system` namespace. If + they are not the same, it's likely that the configmap volume in the pod is + not updated with the latest information. Delete the pod and wait for it to + be recreated. Meanwhile file a bug. 1. Cannot delete a Trigger. - If the Broker doesn't exist, then it's a known issue: [#828](https://github.com/google/knative-gcp/issues/828)