Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support to enable EndpointStatus in Helm chart #15844

Merged
merged 6 commits into from
Apr 27, 2021

Conversation

carloscastrojumo
Copy link
Contributor

@carloscastrojumo carloscastrojumo commented Apr 23, 2021

This commit introduces a new Helm parameter to enable --endpoint-status option in Cilium.

endpointStatus.enabled is disabled by default and endpointStatus.status is required once enabled and suggesting status: policy, controllers, health, log, state.

This aims to activate the values in the columns present in kubectl get cep.

@carloscastrojumo carloscastrojumo requested a review from a team as a code owner April 23, 2021 09:20
@carloscastrojumo carloscastrojumo requested review from a team and kaworu April 23, 2021 09:20
@maintainer-s-little-helper
Copy link

Commit f039d7115c3230cd63663f98300693de5963ddef does not contain "Signed-off-by".

Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/development/contributing_guide/#developer-s-certificate-of-origin

@maintainer-s-little-helper maintainer-s-little-helper bot added dont-merge/needs-sign-off The author needs to add signoff to their commits before merge. dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. labels Apr 23, 2021
@maintainer-s-little-helper maintainer-s-little-helper bot added this to In progress in 1.10.0 Apr 23, 2021
Signed-off-by: Carlos Castro <carlos.castro@jumo.world>
@maintainer-s-little-helper maintainer-s-little-helper bot removed the dont-merge/needs-sign-off The author needs to add signoff to their commits before merge. label Apr 23, 2021
Copy link
Member

@aanm aanm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes, only one small clarification requested.

@@ -129,6 +129,8 @@ contributors across the globe, there is almost always someone available to help.
| encryption.secretName | string | `"cilium-ipsec-keys"` | Name of the Kubernetes secret containing the encryption keys. This option is only effective when encryption.type is set to ipsec. |
| encryption.type | string | `"ipsec"` | Encryption method. Can be either ipsec or wireguard. |
| endpointHealthChecking.enabled | bool | `true` | |
| endpointStatus.enabled | bool | `false` | Enable endpoint status |
| endpointStatus.status | string | `policy` | Endpoint status. Can be policy, health, controllers, logs or state |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it can be all of those parameters, why does it default to policy?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I set it default to policy cause I was thinking most users will set this option true to enable the columns in the cep command but I'm happy to change to empty and required field so users can select the status they want.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated PR and description

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we probably should enable policy by default specifically for this reason. It impacts scale, but we have a scalability guide to instruct users how to get the most scalable setup. On the other hand, disabling this by default means that most users just see the CEP output as broken and it's not obvious why.

@aanm aanm added the release-note/misc This PR makes changes that have no direct user impact. label Apr 23, 2021
@maintainer-s-little-helper maintainer-s-little-helper bot removed the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Apr 23, 2021
@@ -571,6 +571,9 @@ data:
{{- if hasKey .Values.k8s "requireIPv6PodCIDR" }}
k8s-require-ipv6-pod-cidr: {{ .Values.k8s.requireIPv6PodCIDR | quote }}
{{- end }}
{{- if and .Values.endpointStatus .Values.endpointStatus.enabled }}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wouldn't {{- if .Values.endpointStatus.enabled }} be enough here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it would. Updating.

Signed-off-by: Carlos Castro <carlos.castro@jumo.world>
Signed-off-by: Carlos Castro <carlos.castro@jumo.world>
# -- Enable endpoint status
endpointStatus:
enabled: false

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can leave the "status" field here but it would be empty.

@@ -571,6 +571,9 @@ data:
{{- if hasKey .Values.k8s "requireIPv6PodCIDR" }}
k8s-require-ipv6-pod-cidr: {{ .Values.k8s.requireIPv6PodCIDR | quote }}
{{- end }}
{{- if .Values.endpointStatus.enabled }}
endpoint-status: {{ required "endpointStatus.status required: policy, health, controllers, logs or state" .Values.endpointStatus.status | quote }}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would be nice to give an example with 2 or mor options set. for example: "endpointStatus.status required: policy, health, controllers, logs and / or state. For 2 or more options use a comma: "policy, health""

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a good example. Updated.

Signed-off-by: Carlos Castro <carlos.castro@jumo.world>
@aanm aanm removed their assignment Apr 23, 2021
@maintainer-s-little-helper
Copy link

Commit 8c255f6e34c6fa1280f129bf414ad82cec682a8f does not contain "Signed-off-by".

Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/development/contributing_guide/#developer-s-certificate-of-origin

@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-sign-off The author needs to add signoff to their commits before merge. label Apr 25, 2021
@maintainer-s-little-helper
Copy link

Commit 8c255f6e34c6fa1280f129bf414ad82cec682a8f does not contain "Signed-off-by".

Please follow instructions provided in https://docs.cilium.io/en/stable/contributing/development/contributing_guide/#developer-s-certificate-of-origin

Signed-off-by: Carlos Castro <carlos.castro@jumo.world>
@maintainer-s-little-helper maintainer-s-little-helper bot removed the dont-merge/needs-sign-off The author needs to add signoff to their commits before merge. label Apr 25, 2021
Copy link
Member

@kaworu kaworu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution @carloscastrojumo, I have a small comment but the PR looks good to me!

install/kubernetes/cilium/values.yaml Outdated Show resolved Hide resolved
Signed-off-by: Carlos Castro <carlos.castro@jumo.world>
@aanm
Copy link
Member

aanm commented Apr 26, 2021

test-me-please

@kaworu
Copy link
Member

kaworu commented Apr 27, 2021

test-gke

@aanm
Copy link
Member

aanm commented Apr 27, 2021

merging since this is only changing helm and the CI failures might be flakes

@aanm aanm merged commit 8183ebe into cilium:master Apr 27, 2021
1.10.0 automation moved this from In progress to Done Apr 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-note/misc This PR makes changes that have no direct user impact.
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

6 participants