Merge pull request #613 from sdmodi/ccm-readme

Update readme with information about CCM

Author: k8s-ci-robot

README.md

@@ -1,8 +1,10 @@
 # cloud-provider-gcp
 
+This repository holds the code for gcp-controller-manager as well as cloud-controller-manager
+
 ## Publishing gcp-controller-manager image
 
-This command will build and publish
+This command will build and publish gcp-controller-manager
 `gcr.io/k8s-image-staging/gcp-controller-manager:latest`:
 
 ```
@@ -20,6 +22,26 @@ This command will build and publish
 IMAGE_REGISTRY=example.com IMAGE_REPO=my-repo IMAGE_TAG=v1 bazel run //cmd/gcp-controller-manager:publish
 ```
 
+## Publishing cloud-controller-maanger image
+
+This command will build and publish cloud-controller-manager
+`gcr.io/k8s-image-staging/cloud-controller-manager:latest`:
+
+```
+bazel run //cmd/cloud-controller-manager:publish
+```
+
+Environment variables `IMAGE_REGISTRY`, `IMAGE_REPO` and `IMAGE_TAG` can be
+used to override destination GCR repository and tag.
+
+This command will build and publish
+`example.com/my-repo/gcp-controller-manager:v1`:
+
+
+```
+IMAGE_REGISTRY=example.com IMAGE_REPO=my-repo IMAGE_TAG=v1 bazel run //cmd/cloud-controller-manager:publish
+```
+
 # Cross-compiling
 
 Selecting the target platform is done with the `--platforms` option with `bazel`.
@@ -87,3 +109,16 @@ To re-generate `BUILD` files:
 ```sh
 tools/update_bazel.sh
 ```
+
+# Tagging for new cloud-controller-manager versions
+
+To trigger a new image for cloud-controller-manager, you need to add a git tag.
+This needs to have the format `ccm/vX.Y.Z`. For example.
+
+```
+git tag -a ccm/v27.1.0 -m "CCM build for Kubernetes v1.27.1"
+```
+
+The major version X corresponds to the Kubernetes minor version. The minor
+version Y corresponds to the Kubernetes patch version and the patch version Z
+corresponds to the CCM patch version.