You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-4Lines changed: 20 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,8 +8,26 @@
8
8
9
9
## Introduction
10
10
11
-
This repository implements the [cloud provider](https://github.com/kubernetes/cloud-provider) interface for Google Cloud Platform (GCP).
12
-
It provides the [GCP Cloud Controller Manager (CCM)](https://kubernetes.io/docs/concepts/architecture/cloud-controller/), which is necessary for self-managed Kubernetes clusters in GCP and is automatically installed in GKE clusters. It is maintained primarily by the Cloud Kubernetes team at Google.
11
+
This repository implements the [cloud provider](https://github.com/kubernetes/cloud-provider) interface for [Google Cloud Platform (GCP)](https://cloud.google.com/).
12
+
It provides components for Kubernetes clusters running on GCP and is maintained primarily by the Kubernetes team at Google.
13
+
14
+
To see all available commands in this repository, run `make help`.
15
+
16
+
## Components
17
+
18
+
This repository contains the following components, located in `cmd/`:
19
+
20
+
***Cloud Controller Manager (`cloud-controller-manager`)**: The GCP [Cloud Controller Manager (CCM)](https://kubernetes.io/docs/concepts/architecture/cloud-controller/) is responsible for running cloud-provider-dependent controllers (e.g. node health, routing, load balancing, etc.) for Kubernetes clusters running in GCP.
21
+
***GCP Auth Provider (`auth-provider-gcp`)**: A GCP [Container Runtime Interface (CRI)](https://kubernetes.io/docs/concepts/containers/cri/) plugin for fetching credentials for kubelet to pull images from [Google Container Registry (GCR)](https://cloud.google.com/container-registry) and [Artifact Registry (AR)](https://cloud.google.com/artifact-registry) when needed for pods.
22
+
***GKE Auth Plugin (`gke-gcloud-auth-plugin`)**: A client-go credential plugin that provides Google Cloud access tokens to `kubectl` and other Kubernetes clients for authenticating to [GKE clusters](https://cloud.google.com/kubernetes-engine), e.g. in `gcloud container clusters get-credentials`.
23
+
24
+
## Testing
25
+
26
+
This repository includes several testing commands you can run locally during development:
27
+
28
+
***`make test`**: Runs the standard Go unit tests.
29
+
***`make verify`**: Runs all verification scripts (format, lint, etc.).
30
+
***`make run-e2e-test`**: Runs the E2E test suite on a provisional [kOps](https://kops.sigs.k8s.io/) cluster.
13
31
14
32
## Publishing cloud-controller-manager image
15
33
@@ -28,8 +46,6 @@ If `IMAGE_REPO` is not set, the script will exit with an error. If `IMAGE_TAG` i
28
46
29
47
### Docker Commands
30
48
31
-
Run `make help` to see all available commands.
32
-
33
49
**Note:** To push images to Google Artifact Registry, you must first authenticate Docker by running the following command:
0 commit comments