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

Change boolean annotation values to string #2839

Merged
merged 1 commit into from Feb 16, 2018
Merged

Conversation

hobti01
Copy link
Contributor

@hobti01 hobti01 commented Feb 12, 2018

What does this PR do?

Update annotations documentation

Motivation

Kubernetes annotation values must be strings.
Booleans and numbers are not valid types.
Unfortunately no clear upstream documentation exists stating this.

More

  • Added/updated documentation

Additional Notes

Kubernetes annotation values must be strings. Booleans and numbers are not valid types. Unfortunately no clear upstream documentation exists stating this.

Annotations
Annotations have same requirements as labels
GetAnnotations accessor returns string map

Formatting to add space between colon and value.

Copy link
Contributor

@timoreimann timoreimann left a comment

Choose a reason for hiding this comment

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

Good catch, thanks. 👏

This should go into the v1.5 branch first perhaps. I'll let @ldez decide.

Copy link
Contributor

@errm errm left a comment

Choose a reason for hiding this comment

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

LGTM... @timoreimann agreed that it should go into the release branch also

@ldez ldez self-assigned this Feb 13, 2018
@ldez
Copy link
Member

ldez commented Feb 16, 2018

My main problem is that the documentation on this part has been completely rewritten in master.
It's not possible to just rebase.
This must be done in 2 PRs.

@ldez ldez removed the bot/no-merge label Feb 16, 2018
@ldez ldez added this to the 1.6 milestone Feb 16, 2018
Copy link
Member

@ldez ldez left a comment

Choose a reason for hiding this comment

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

LGTM

Kubernetes annotation values must be strings.  Booleans and numbers are not valid types.  Unfortunately no clear documentation exists stating this.
[Annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/)
[Annotations have same requirements as labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set)
[GetAnnotations accessor returns string map](https://github.com/kubernetes/kubernetes/blob/f5f6f3e715cb8dfbd9657a4229c77ec6a5eab135/staging/src/k8s.io/apimachinery/pkg/api/meta/meta.go#L583)

Formatting to add space between colon and value.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants