feat: Project Service List local CRD function

examples/enable-gcp-services-advanced/.expected/diff.patch

@@ -0,0 +1,16 @@
+diff --git a/service_proj1-service-bigquery.yaml b/service_proj1-service-bigquery.yaml
+deleted file mode 100644
+index 42300cc..0000000
+--- a/service_proj1-service-bigquery.yaml
++++ /dev/null
+@@ -1,10 +0,0 @@
+-apiVersion: serviceusage.cnrm.cloud.google.com/v1beta1
+-kind: Service
+-metadata:
+-  name: proj1-service-bigquery
+-  annotations:
+-    blueprints.cloud.google.com/ownerReference: 'blueprints.cloud.google.com/ProjectServiceSet/proj1-service'
+-spec:
+-  resourceID: bigquery.googleapis.com
+-  projectRef:
+-    external: proj1

examples/enable-gcp-services-advanced/.expected/results.yaml

@@ -0,0 +1,41 @@
+apiVersion: kpt.dev/v1
+kind: FunctionResultList
+metadata:
+  name: fnresults
+exitCode: 0
+items:
+  - image: gcr.io/kpt-fn/enable-gcp-services:unstable
+    exitCode: 0
+    results:
+      - message: pruned service
+        severity: info
+        resourceRef:
+          apiVersion: serviceusage.cnrm.cloud.google.com/v1beta1
+          kind: Service
+          name: proj1-service-bigquery
+        file:
+          path: service_proj1-service-bigquery.yaml
+      - message: recreated service
+        severity: info
+        resourceRef:
+          apiVersion: serviceusage.cnrm.cloud.google.com/v1beta1
+          kind: Service
+          name: proj1-service-compute
+        file:
+          path: service_proj1-service-compute.yaml
+      - message: recreated service
+        severity: info
+        resourceRef:
+          apiVersion: serviceusage.cnrm.cloud.google.com/v1beta1
+          kind: Service
+          name: proj1-service-redis
+        file:
+          path: service_proj1-service-redis.yaml
+      - message: recreated service
+        severity: info
+        resourceRef:
+          apiVersion: serviceusage.cnrm.cloud.google.com/v1beta1
+          kind: Service
+          name: proj2-service-redis
+        file:
+          path: service_proj2-service-redis.yaml

examples/enable-gcp-services-advanced/.krmignore

@@ -0,0 +1 @@
+.expected

examples/enable-gcp-services-advanced/Kptfile

@@ -0,0 +1,7 @@
+apiVersion: kpt.dev/v1
+kind: Kptfile
+metadata:
+  name: enable-gcp-services-advanced
+pipeline:
+  mutators:
+    - image: gcr.io/kpt-fn/enable-gcp-services:unstable

examples/enable-gcp-services-advanced/README.md

@@ -0,0 +1,74 @@
+# enable-gcp-services: Advanced Example
+
+### Overview
+
+In this example, we will see how to generate [project services](https://cloud.google.com/config-connector/docs/reference/resource-docs/serviceusage/service) for multiple projects and how service pruning is done.
+
+### Fetch the example package
+
+Get the example package by running the following commands:
+
+```shell
+$ kpt pkg get https://github.com/GoogleContainerTools/kpt-functions-catalog.git/examples/enable-gcp-services-advanced
+```
+
+Explore the package by running:
+```shell
+$ kpt pkg tree enable-gcp-services-advanced
+Package "enable-gcp-services-advanced"
+├── [Kptfile]  Kptfile enable-gcp-services-advanced
+├── [proj1-services.yaml]  ProjectServiceSet proj1-service
+├── [proj2-services.yaml]  ProjectServiceSet proj2-service
+├── [resources.yaml]  ComputeNetwork computenetwork-sample
+├── [resources.yaml]  RedisInstance redisinstance-sample
+├── [service_proj1-service-bigquery.yaml]  Service proj1-service-bigquery
+├── [service_proj1-service-compute.yaml]  Service proj1-service-compute
+├── [service_proj1-service-redis.yaml]  Service proj1-service-redis
+└── [service_proj2-service-redis.yaml]  Service proj2-service-redis
+```
+
+We can see two ProjectServiceSet resources `proj1-service` and `proj2-service` for managing service enablement in two projects `proj1` and `proj2`. We can also see the services `compute.googleapis.com`, `redis.googleapis.com` managed within ProjectServiceSet `proj1-service` resource and `redis.googleapis.com` within ProjectServiceSet `proj2-service` resource. Notice that `bigquery.googleapis.com` is no longer present in `proj1-service` ProjectServiceSet. We can re render this package to prune that service resource.
+
+### Function invocation
+
+Render the configuration, `enable-gcp-services` has been defined declaratively in the Kptfile.
+
+```shell
+$ kpt fn render enable-gcp-services-advanced
+```
+
+### Expected result
+
+```shell
+Package "enable-gcp-services-advanced": 
+[RUNNING] "gcr.io/kpt-fn/enable-gcp-services:unstable"
+[PASS] "gcr.io/kpt-fn/enable-gcp-services:unstable"
+  Results:
+    [INFO] pruned service in object "serviceusage.cnrm.cloud.google.com/v1beta1/Service/proj1-service-bigquery" in file "service_proj1-service-bigquery.yaml"
+    [INFO] recreated service in object "serviceusage.cnrm.cloud.google.com/v1beta1/Service/proj1-service-compute" in file "service_proj1-service-compute.yaml"
+    [INFO] recreated service in object "serviceusage.cnrm.cloud.google.com/v1beta1/Service/proj1-service-redis" in file "service_proj1-service-redis.yaml"
+    [INFO] recreated service in object "serviceusage.cnrm.cloud.google.com/v1beta1/Service/proj2-service-redis" in file "service_proj2-service-redis.yaml"
+
+Successfully executed 1 function(s) in 1 package(s).
+```
+
+We can see that the `bigquery` service resource was pruned. Run the following command to see current service resources:
+
+```shell
+$ kpt pkg tree enable-gcp-services-advanced
+```
+
+We can see `proj1-service-bigquery` no longer exists.
+
+```diff
+Package "enable-gcp-services-advanced"
+ ├── [Kptfile]  Kptfile enable-gcp-services-advanced
+ ├── [proj1-services.yaml]  ProjectServiceSet proj1-service
+ ├── [proj2-services.yaml]  ProjectServiceSet proj2-service
+ ├── [resources.yaml]  ComputeNetwork computenetwork-sample
+ ├── [resources.yaml]  RedisInstance redisinstance-sample
+-├── [service_proj1-service-bigquery.yaml]  Service proj1-service-bigquery
+ ├── [service_proj1-service-compute.yaml]  Service proj1-service-compute
+ ├── [service_proj1-service-redis.yaml]  Service proj1-service-redis
+ └── [service_proj2-service-redis.yaml]  Service proj2-service-redis
+```

examples/enable-gcp-services-advanced/proj1-services.yaml

@@ -0,0 +1,11 @@
+apiVersion: blueprints.cloud.google.com/v1alpha1
+kind: ProjectServiceSet
+metadata:
+  name: proj1-service
+  annotations:
+    config.kubernetes.io/local-config: "true"
+spec:
+  services:
+    - compute.googleapis.com
+    - redis.googleapis.com
+  projectID: proj1

examples/enable-gcp-services-advanced/proj2-services.yaml

@@ -0,0 +1,10 @@
+apiVersion: blueprints.cloud.google.com/v1alpha1
+kind: ProjectServiceSet
+metadata:
+  name: proj2-service
+  annotations:
+    config.kubernetes.io/local-config: "true"
+spec:
+  services:
+    - redis.googleapis.com
+  projectID: proj2

examples/enable-gcp-services-advanced/service_proj1-service-bigquery.yaml

@@ -0,0 +1,10 @@
+apiVersion: serviceusage.cnrm.cloud.google.com/v1beta1
+kind: Service
+metadata:
+  name: proj1-service-bigquery
+  annotations:
+    blueprints.cloud.google.com/ownerReference: 'blueprints.cloud.google.com/ProjectServiceSet/proj1-service'
+spec:
+  resourceID: bigquery.googleapis.com
+  projectRef:
+    external: proj1

examples/enable-gcp-services-advanced/service_proj1-service-compute.yaml

@@ -0,0 +1,10 @@
+apiVersion: serviceusage.cnrm.cloud.google.com/v1beta1
+kind: Service
+metadata:
+  name: proj1-service-compute
+  annotations:
+    blueprints.cloud.google.com/ownerReference: 'blueprints.cloud.google.com/ProjectServiceSet/proj1-service'
+spec:
+  resourceID: compute.googleapis.com
+  projectRef:
+    external: proj1

examples/enable-gcp-services-advanced/service_proj1-service-redis.yaml

@@ -0,0 +1,10 @@
+apiVersion: serviceusage.cnrm.cloud.google.com/v1beta1
+kind: Service
+metadata:
+  name: proj1-service-redis
+  annotations:
+    blueprints.cloud.google.com/ownerReference: 'blueprints.cloud.google.com/ProjectServiceSet/proj1-service'
+spec:
+  resourceID: redis.googleapis.com
+  projectRef:
+    external: proj1

examples/enable-gcp-services-advanced/service_proj2-service-redis.yaml

@@ -0,0 +1,10 @@
+apiVersion: serviceusage.cnrm.cloud.google.com/v1beta1
+kind: Service
+metadata:
+  name: proj2-service-redis
+  annotations:
+    blueprints.cloud.google.com/ownerReference: 'blueprints.cloud.google.com/ProjectServiceSet/proj2-service'
+spec:
+  resourceID: redis.googleapis.com
+  projectRef:
+    external: proj2

examples/enable-gcp-services-simple/.expected/diff.patch

@@ -0,0 +1,32 @@
+diff --git a/service_proj1-service-compute.yaml b/service_proj1-service-compute.yaml
+new file mode 100644
+index 0000000..a0e4c9b
+--- /dev/null
++++ b/service_proj1-service-compute.yaml
+@@ -0,0 +1,10 @@
++apiVersion: serviceusage.cnrm.cloud.google.com/v1beta1
++kind: Service
++metadata:
++  name: proj1-service-compute
++  annotations:
++    blueprints.cloud.google.com/ownerReference: 'blueprints.cloud.google.com/ProjectServiceSet/proj1-service'
++spec:
++  resourceID: compute.googleapis.com
++  projectRef:
++    external: proj1
+diff --git a/service_proj1-service-redis.yaml b/service_proj1-service-redis.yaml
+new file mode 100644
+index 0000000..2da01b0
+--- /dev/null
++++ b/service_proj1-service-redis.yaml
+@@ -0,0 +1,10 @@
++apiVersion: serviceusage.cnrm.cloud.google.com/v1beta1
++kind: Service
++metadata:
++  name: proj1-service-redis
++  annotations:
++    blueprints.cloud.google.com/ownerReference: 'blueprints.cloud.google.com/ProjectServiceSet/proj1-service'
++spec:
++  resourceID: redis.googleapis.com
++  projectRef:
++    external: proj1

examples/enable-gcp-services-simple/.expected/results.yaml

@@ -0,0 +1,25 @@
+apiVersion: kpt.dev/v1
+kind: FunctionResultList
+metadata:
+  name: fnresults
+exitCode: 0
+items:
+  - image: gcr.io/kpt-fn/enable-gcp-services:unstable
+    exitCode: 0
+    results:
+      - message: generated service
+        severity: info
+        resourceRef:
+          apiVersion: serviceusage.cnrm.cloud.google.com/v1beta1
+          kind: Service
+          name: proj1-service-compute
+        file:
+          path: service_proj1-service-compute.yaml
+      - message: generated service
+        severity: info
+        resourceRef:
+          apiVersion: serviceusage.cnrm.cloud.google.com/v1beta1
+          kind: Service
+          name: proj1-service-redis
+        file:
+          path: service_proj1-service-redis.yaml

examples/enable-gcp-services-simple/.krmignore

@@ -0,0 +1 @@
+.expected

examples/enable-gcp-services-simple/Kptfile

@@ -0,0 +1,7 @@
+apiVersion: kpt.dev/v1
+kind: Kptfile
+metadata:
+  name: enable-gcp-services-simple
+pipeline:
+  mutators:
+    - image: gcr.io/kpt-fn/enable-gcp-services:unstable

examples/enable-gcp-services-simple/README.md

@@ -0,0 +1,49 @@
+# enable-gcp-services: Simple Example
+
+### Overview
+
+In this example, we will see how to generate [project services](https://cloud.google.com/config-connector/docs/reference/resource-docs/serviceusage/service) for `compute.googleapis.com` and `redis.googleapis.com`.
+
+### Fetch the example package
+
+Get the example package by running the following commands:
+
+```shell
+$ kpt pkg get https://github.com/GoogleContainerTools/kpt-functions-catalog.git/examples/enable-gcp-services-simple
+```
+
+### Function invocation
+
+Render the configuration, `enable-gcp-services` has been defined declaratively in the Kptfile.
+
+```shell
+$ kpt fn render enable-gcp-services-simple
+```
+
+### Expected result
+
+```shell
+[RUNNING] "gcr.io/kpt-fn/enable-gcp-services:unstable"
+[PASS] "gcr.io/kpt-fn/enable-gcp-services:unstable"
+  Results:
+    [INFO] generated service in object "serviceusage.cnrm.cloud.google.com/v1beta1/Service/proj1-service-compute"
+    [INFO] generated service in object "serviceusage.cnrm.cloud.google.com/v1beta1/Service/proj1-service-redis"
+
+Successfully executed 1 function(s) in 1 package(s).
+```
+
+Run the following command to see generated service resources:
+
+```shell
+$ kpt pkg tree enable-gcp-services-simple
+```
+
+You will see two new generated resources `proj1-service-compute` and `proj1-service-redis`.
+
+```shell
+Package "enable-gcp-services-simple"
+├── [Kptfile]  Kptfile enable-gcp-services-simple
+├── [service_proj1-service-compute.yaml]  Service proj1-service-compute
+├── [service_proj1-service-redis.yaml]  Service proj1-service-redis
+└── [services.yaml]  ProjectServiceList proj1-service
+```

examples/enable-gcp-services-simple/services.yaml

@@ -0,0 +1,11 @@
+apiVersion: blueprints.cloud.google.com/v1alpha1
+kind: ProjectServiceSet
+metadata:
+  name: proj1-service
+  annotations:
+    config.kubernetes.io/local-config: "true"
+spec:
+  services:
+    - compute.googleapis.com
+    - redis.googleapis.com
+  projectID: proj1

functions/go/Makefile

@@ -21,6 +21,7 @@ GOBIN := $(shell go env GOPATH)/bin
 FUNCTIONS := \
 	apply-setters \
 	create-setters \
+	enable-gcp-services \
 	ensure-name-substring \
 	fix \
 	format \

functions/go/enable-gcp-services/Dockerfile

@@ -0,0 +1,15 @@
+FROM golang:1.16-alpine3.13
+ENV CGO_ENABLED=0
+WORKDIR /go/src/
+
+COPY go.mod go.sum ./
+RUN go mod download
+
+COPY . .
+RUN go build -o /usr/local/bin/function ./
+
+#############################################
+
+FROM alpine:3.13
+COPY --from=0 /usr/local/bin/function /usr/local/bin/function
+ENTRYPOINT ["function"]