fix of helm installation command in doc #3333

ashutosji · 2023-08-18T08:44:22Z

What type of PR is this?

Uncomment only one /kind <> line, press enter to put that in a new line, and remove leading whitespace from that line:

/kind breaking
/kind bug
/kind cleanup
/kind documentation
/kind feature
/kind hotfix
/kind release

What this PR does / Why we need it: This will fix helm installation command when we are using control TLS certificate.

Which issue(s) this PR fixes: #3323

Closes #3323

Special notes for your reviewer:

agones-bot · 2023-08-18T09:47:18Z

Build Succeeded 👏

Build Id: cddd882d-8e26-4403-a45d-3f79610527c5

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

https://38c9e8a-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3333/head:pr_3333 && git checkout pr_3333
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.35.0-dev-38c9e8a-amd64

markmandel · 2023-08-21T22:59:54Z

site/content/en/docs/Installation/Install Agones/helm.md

-  --set agones.controller.customCertSecretPath[1].key='tls.crt',customCertSecretPath[1].path='server.crt'
-  --set agones.controller.customCertSecretPath[2].key='tls.key',customCertSecretPath[2].path='server.key'
-  --set agones.controller.allocationApiService.annotations={'cert-manager.io/inject-ca-from': 'agones-system/my-release-cert'} \
+  --set-string "agones.controller.customCertSecretPath[0].key=ca.crt" \


I'm actually thinking - let's remove this top section with all the --set commands, I don't think anyone would do it in practice, and it's far easier to read with the yaml file.

So let's just keep the YAML file version (unless anyone disagrees?)

Sure, changes added!

agones-bot · 2023-08-22T07:37:50Z

Build Succeeded 👏

Build Id: 7d8d436a-5add-4d5b-95a1-6b62ec19725b

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

https://a571395-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3333/head:pr_3333 && git checkout pr_3333
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.35.0-dev-a571395-amd64

markmandel

Just some small wording nits, but otherwise, looks great!

markmandel · 2023-08-22T19:50:47Z

site/content/en/docs/Installation/Install Agones/helm.md

  issuerRef:
    name: selfsigned
    kind: ClusterIssuer
 EOF
 ```

-After the certificates are generated, we will want to [inject caBundle](https://cert-manager.io/docs/concepts/ca-injector/) into controller webhook and disable controller secret creation by setting the following:
+After the certificates are generated, we will want to [inject caBundle](https://cert-manager.io/docs/concepts/ca-injector/) into controller and extensions webhook and disable controller and extensions secret creation by using yaml file. This process avoids the cluter of passing too many parameters to helm install command. Please refer below `file_name.yaml` file:


Nit: some sentence structure.

Suggested change

After the certificates are generated, we will want to [inject caBundle](https://cert-manager.io/docs/concepts/ca-injector/) into controller and extensions webhook and disable controller and extensions secret creation by using yaml file. This process avoids the cluter of passing too many parameters to helm install command. Please refer below `file_name.yaml` file:

After the certificates are generated, we will want to [inject caBundle](https://cert-manager.io/docs/concepts/ca-injector/) into the controller and extensions webhook and disable the controller and extensions secret creation through the following values.yaml file.:

markmandel · 2023-08-22T19:51:08Z

site/content/en/docs/Installation/Install Agones/helm.md


+```


Just for some syntax highlighting.

Suggested change

```

```yaml

markmandel · 2023-08-22T19:51:35Z

site/content/en/docs/Installation/Install Agones/helm.md

+      disableCaBundle: true
+```
+
+After, creating yaml file use below command to install Agones:


Suggested change

After, creating yaml file use below command to install Agones:

After copying the above yaml into a `values.yaml` file, use below command to install Agones:

markmandel · 2023-08-22T19:51:46Z

site/content/en/docs/Installation/Install Agones/helm.md

-  --set agones.controller.mutatingWebhook.disableCaBundle=true \
-  --namespace agones-system --create-namespace  \
-  agones/agones
+helm install my-release --namespace agones-system --create-namespace --values /path/file_name.yaml agones/agones


Suggested change

helm install my-release --namespace agones-system --create-namespace --values /path/file_name.yaml agones/agones

helm install my-release --namespace agones-system --create-namespace --values values.yaml agones/agones

Thanks for suggestions! I have updated the PR.

agones-bot · 2023-08-23T07:36:43Z

Build Succeeded 👏

Build Id: 0888032d-f26c-48d1-88e7-3435a8fa7d13

The following development artifacts have been built, and will exist for the next 30 days:

A preview of the website (the last 30 builds are retained):

https://762c545-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/3333/head:pr_3333 && git checkout pr_3333
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.35.0-dev-762c545-amd64

google-oss-prow · 2023-08-24T21:18:03Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ashutosji, markmandel

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [markmandel]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

google-oss-prow bot requested review from EricFortin and roberthbailey August 18, 2023 08:44

google-oss-prow bot added the size/M label Aug 18, 2023

github-actions bot added the kind/documentation Documentation for Agones label Aug 18, 2023

markmandel reviewed Aug 21, 2023

View reviewed changes

ashutosji force-pushed the update-helm-installation branch from 38c9e8a to a571395 Compare August 22, 2023 06:41

markmandel reviewed Aug 22, 2023

View reviewed changes

ashutosji added 3 commits August 23, 2023 11:57

fix of helm installation command in doc

3a56b1f

removed helm just keeping yaml file

a3744af

added suggested changes

762c545

ashutosji force-pushed the update-helm-installation branch from a571395 to 762c545 Compare August 23, 2023 06:38

markmandel approved these changes Aug 24, 2023

View reviewed changes

google-oss-prow bot assigned markmandel Aug 24, 2023

google-oss-prow bot added the lgtm label Aug 24, 2023

markmandel merged commit cb14489 into googleforgames:main Aug 24, 2023

google-oss-prow bot added the approved label Aug 24, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix of helm installation command in doc #3333

fix of helm installation command in doc #3333

ashutosji commented Aug 18, 2023

agones-bot commented Aug 18, 2023

markmandel Aug 21, 2023

ashutosji Aug 22, 2023

agones-bot commented Aug 22, 2023

markmandel left a comment

markmandel Aug 22, 2023

markmandel Aug 22, 2023

markmandel Aug 22, 2023

markmandel Aug 22, 2023

ashutosji Aug 23, 2023

agones-bot commented Aug 23, 2023

google-oss-prow bot commented Aug 24, 2023

	After the certificates are generated, we will want to [inject caBundle](https://cert-manager.io/docs/concepts/ca-injector/) into controller and extensions webhook and disable controller and extensions secret creation by using yaml file. This process avoids the cluter of passing too many parameters to helm install command. Please refer below `file_name.yaml` file:
	After the certificates are generated, we will want to [inject caBundle](https://cert-manager.io/docs/concepts/ca-injector/) into the controller and extensions webhook and disable the controller and extensions secret creation through the following values.yaml file.:

	After, creating yaml file use below command to install Agones:
	After copying the above yaml into a `values.yaml` file, use below command to install Agones:

	helm install my-release --namespace agones-system --create-namespace --values /path/file_name.yaml agones/agones
	helm install my-release --namespace agones-system --create-namespace --values values.yaml agones/agones

fix of helm installation command in doc #3333

fix of helm installation command in doc #3333

Conversation

ashutosji commented Aug 18, 2023

agones-bot commented Aug 18, 2023

markmandel Aug 21, 2023

Choose a reason for hiding this comment

ashutosji Aug 22, 2023

Choose a reason for hiding this comment

agones-bot commented Aug 22, 2023

markmandel left a comment

Choose a reason for hiding this comment

markmandel Aug 22, 2023

Choose a reason for hiding this comment

markmandel Aug 22, 2023

Choose a reason for hiding this comment

markmandel Aug 22, 2023

Choose a reason for hiding this comment

markmandel Aug 22, 2023

Choose a reason for hiding this comment

ashutosji Aug 23, 2023

Choose a reason for hiding this comment

agones-bot commented Aug 23, 2023

google-oss-prow bot commented Aug 24, 2023