Add clearer instructions for kapp-controller in openshift+gcp

[joaopapereira]

No description provided.

[joe-kimmel-vmw]

just my $0.02: no need for this line with the hashes in it as it will be different for everyone

[joaopapereira]

the SHA's are not relevant because I made this diff outside a repository. But I can remove them

[joe-kimmel-vmw]

i guess technically for versions that have been released this SHA will never change but i'd be tempted to truncate it or something in order to indicate that it will not change (ie it would be a mistake to copy-paste this line in a few months, because you almost surely want a different SHA here)

[joaopapereira]

The problem here is the diff needs a reference and that is the first line after the env....

[aaronshurley]

Thinking out loud... How important is the diff info? I'm not sure if it adds value for me. In the spirit of simplification and preventing misuse, would it be simpler if we provided just enough info for users to add this value themselves? A couple more options come to mind:

Option A: snippet of release.yml with just enough structural information

---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: kapp-controller
spec:
  template:
    spec:
      containers:
        - name: kapp-controller-sidecarexec
          env:
          - name: IMGPKG_ENABLE_IAAS_AUTH # add this name and value
            value: false

Option B: provide a mapping to the property

1. Open the release yaml
2. Navigate to the kapp-controller Deployment
3. Add the environment variable to spec.template.spec.containers[name: kapp-controller-sidecarexec].env:

   - name: IMGPKG_ENABLE_IAAS_AUTH # add this name and value
     value: false
   

Note: I suspect that containers[name: kapp-controller-sidecarexec] is invalid but I hope it demonstrates the idea. Perhaps we'd find the "right" way to map it following jq's syntax or something.

Just sharing some ideas, don't consider this comment blocking.

[aaronshurley]

I shared my thoughts but my comments are not blocking.

[aaronshurley]

I think we could remove the resources: line as it doesn't add anything to the snippet.

[aaronshurley]

Thinking out loud... How important is the diff info? I'm not sure if it adds value for me. In the spirit of simplification and preventing misuse, would it be simpler if we provided just enough info for users to add this value themselves? A couple more options come to mind:

Option A: snippet of release.yml with just enough structural information

---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: kapp-controller
spec:
  template:
    spec:
      containers:
        - name: kapp-controller-sidecarexec
          env:
          - name: IMGPKG_ENABLE_IAAS_AUTH # add this name and value
            value: false

Option B: provide a mapping to the property

1. Open the release yaml
2. Navigate to the kapp-controller Deployment
3. Add the environment variable to spec.template.spec.containers[name: kapp-controller-sidecarexec].env:

   - name: IMGPKG_ENABLE_IAAS_AUTH # add this name and value
     value: false
   

Note: I suspect that containers[name: kapp-controller-sidecarexec] is invalid but I hope it demonstrates the idea. Perhaps we'd find the "right" way to map it following jq's syntax or something.

Just sharing some ideas, don't consider this comment blocking.