Generate CR docs (#205)

* Generate CR docs

* Changelog

* Handle line breaks for Backend examples

CHANGELOG.md

@@ -5,6 +5,7 @@ CHANGELOG
 - Fix clean up logic on reconcile [#203](https://github.com/pulumi/pulumi-kubernetes-operator/pull/203)
 - Fix stack refresh for BYO backend [#200](https://github.com/pulumi/pulumi-kubernetes-operator/pull/200)
 - Bump to pulumi v3.13.2 [#207](https://github.com/pulumi/pulumi-kubernetes-operator/pull/207)
+- Add docs for Stack CR [#205](https://github.com/pulumi/pulumi-kubernetes-operator/pull/205)
 
 ## 0.0.20 (2021-09-27)
 - Improve workdir cleanup logic [#195](https://github.com/pulumi/pulumi-kubernetes-operator/pull/195)

Makefile

@@ -10,17 +10,23 @@ default: build
 install-crds:
 	kubectl apply -f deploy/crds/pulumi.com_stacks.yaml
 
-codegen: install-controller-gen generate-k8s generate-crds
+codegen: install-controller-gen install-crdoc generate-k8s generate-crds generate-crdocs
 
 install-controller-gen:
 	@echo "Installing controller-gen to GOPATH/bin"; pushd /tmp >& /dev/null && go install sigs.k8s.io/controller-tools/cmd/[email protected] ; popd >& /dev/null
 
+install-crdoc:
+	@echo "Installing crdoc to go GOPATH/bin"; pushd /tmp >& /dev/null && go install fybrik.io/[email protected]; popd >& /dev/null
+
 generate-crds:
 	./scripts/generate_crds.sh
 
 generate-k8s:
 	./scripts/generate_k8s.sh
 
+generate-crdocs:
+	crdoc --resources deploy/crds/pulumi.com_stacks.yaml --output docs/stacks.md
+
 build-image: build-static
 	docker build --rm -t $(IMAGE_NAME):$(VERSION) -f Dockerfile .
 

README.md

@@ -910,6 +910,10 @@ Check out [Create Pulumi Stacks using Pulumi](./docs/create-stacks-using-pulumi.
 - [Managing a Kubernetes Blue/Green Deployment](./examples/blue-green)
 - [AWS S3 Buckets](./examples/aws-s3)
 
+### Stack CR Documentation
+
+- Detailed documentation on Stack Custom Resource is available [here](./docs/stacks.md)
+
 ## Development
 
 Check out [docs/build.md](./docs/build.md) for more details on building and

deploy/crds/pulumi.com_stacks.yaml

@@ -36,7 +36,7 @@ spec:
                 description: '(optional) AccessTokenSecret is the name of a secret containing the PULUMI_ACCESS_TOKEN for Pulumi access. Deprecated: use EnvRefs with a "secret" entry with the key PULUMI_ACCESS_TOKEN instead.'
                 type: string
               backend:
-                description: '(optional) Backend is an optional backend URL to use for all Pulumi operations. Examples:   - Pulumi Service:              "https://app.pulumi.com" (default)   - Self-managed Pulumi Service: "https://pulumi.acmecorp.com"   - Local:                       "file://./einstein"   - AWS:                         "s3://<my-pulumi-state-bucket>"   - Azure:                       "azblob://<my-pulumi-state-bucket>"   - GCP:                         "gs://<my-pulumi-state-bucket>" See: https://www.pulumi.com/docs/intro/concepts/state/'
+                description: '(optional) Backend is an optional backend URL to use for all Pulumi operations.<br/> Examples:<br/>   - Pulumi Service:              "https://app.pulumi.com" (default)<br/>   - Self-managed Pulumi Service: "https://pulumi.acmecorp.com" <br/>   - Local:                       "file://./einstein" <br/>   - AWS:                         "s3://<my-pulumi-state-bucket>" <br/>   - Azure:                       "azblob://<my-pulumi-state-bucket>" <br/>   - GCP:                         "gs://<my-pulumi-state-bucket>" <br/> See: https://www.pulumi.com/docs/intro/concepts/state/'
                 type: string
               branch:
                 description: (optional) Branch is the branch name to deploy, either the simple or fully qualified ref name, e.g. refs/heads/master. This is mutually exclusive with the Commit setting. Either value needs to be specified.