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.

Sign up for GitHub

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

Jump to bottom

Document all the fields in the Cilium spec #8559

Merged
merged 8 commits into from
Mar 13, 2020
Merged

Document all the fields in the Cilium spec #8559

merged 8 commits into from
Mar 13, 2020

Conversation

olemarkus
Copy link
Member

Since there is a massive amount of fields to document, I only added the docs to one of the packages so far. I will add to the other two if there is no problem with the docs I added here.

@k8s-ci-robot k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Feb 14, 2020
@k8s-ci-robot
Copy link
Contributor

Hi @olemarkus. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 14, 2020
@hakman
Copy link
Member

hakman commented Feb 14, 2020

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Feb 14, 2020
@johngmyers
Copy link
Member

https://github.com/golang/go/wiki/CodeReviewComments#comment-sentences

@olemarkus olemarkus force-pushed the cilium-deprecate-unused-fields branch from a169697 to 73fb299 Compare February 22, 2020 19:58
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 22, 2020
johngmyers
johngmyers requested changes Mar 2, 2020
View reviewed changes
Copy link
Member

@johngmyers johngmyers 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 doing this!

pkg/apis/kops/networking.go Outdated Show resolved Hide resolved
pkg/apis/kops/networking.go Outdated Show resolved Hide resolved
pkg/apis/kops/networking.go Outdated Show resolved Hide resolved
pkg/apis/kops/networking.go Outdated Show resolved Hide resolved
pkg/apis/kops/networking.go Outdated Show resolved Hide resolved
pkg/apis/kops/networking.go Show resolved Hide resolved
pkg/apis/kops/networking.go Outdated Show resolved Hide resolved
pkg/apis/kops/networking.go Outdated
// Ipam determines which IP address allocation mode to use.
// "eni" will use AWS native networking for pods
Ipam string `json:"ipam,omitempty"`
// IPTablesRulesNoinstall determins if the base iptables rules for cilium to mainly interact with kube-proxy (and masquerading)
Copy link
Member

Choose a reason for hiding this comment

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

"determins" is a typo and it looks like a verb is missing.
Perhaps something more like "IPTablesRulesNoinstall disables installing the base IPTables rules used for masquerading and kube-proxy."

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks

pkg/apis/kops/networking.go Outdated Show resolved Hide resolved
pkg/apis/kops/networking.go Outdated Show resolved Hide resolved
johngmyers
johngmyers requested changes Mar 3, 2020
View reviewed changes
pkg/apis/kops/networking.go Show resolved Hide resolved
pkg/apis/kops/networking.go Outdated Show resolved Hide resolved
pkg/apis/kops/networking.go
EnableNodePort bool `json:"enableNodePort"`
Ipam string `json:"ipam,omitempty"`
// Ipam determines the IP address allocation mode to use.
// "eni" will use AWS native networking for pods. Eni requires masquerade to be set to false.
Copy link
Member

Choose a reason for hiding this comment

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

It looks like the possible values are "crd", "eni", and "azure". These should be documented.

Copy link
Member Author

Choose a reason for hiding this comment

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

"crd" should work out of the box. Kops wouldn't support azure though.

pkg/apis/kops/networking.go Outdated Show resolved Hide resolved
pkg/apis/kops/networking.go Outdated Show resolved Hide resolved
pkg/apis/kops/networking.go Outdated Show resolved Hide resolved
olemarkus and others added 2 commits March 3, 2020 19:12
@olemarkus @johngmyers
Apply suggestions from code review
4f17852 
Co-Authored-By: John Gardiner Myers <jgmyers@proofpoint.com>
More documentation changes
3fc80bc
johngmyers
johngmyers reviewed Mar 4, 2020
View reviewed changes
Copy link
Member

@johngmyers johngmyers left a comment

Choose a reason for hiding this comment

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

With that possible suggestion I believe we are ready to copy into the versioned APIs.

pkg/apis/kops/networking.go Show resolved Hide resolved
olemarkus and others added 2 commits March 4, 2020 20:14
@olemarkus @johngmyers
Apply suggestions from code review
8338824 
Co-Authored-By: John Gardiner Myers <jgmyers@proofpoint.com>
Add the docs to the api specs
3a32b76
@k8s-ci-robot k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. area/api and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Mar 12, 2020
@olemarkus olemarkus changed the title WIP: Document all the fields in the Cilium spec Document all the fields in the Cilium spec Mar 12, 2020
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 12, 2020
@johngmyers
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 13, 2020
@rifelpet
Copy link
Member

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: olemarkus, rifelpet

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:

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 13, 2020
@k8s-ci-robot k8s-ci-robot merged commit d6a2daf into kubernetes:master Mar 13, 2020
@k8s-ci-robot k8s-ci-robot added this to the v1.18 milestone Mar 13, 2020
@olemarkus olemarkus deleted the cilium-deprecate-unused-fields branch March 25, 2020 20:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@johngmyers johngmyers johngmyers requested changes

@joshbranham joshbranham Awaiting requested review from joshbranham

@robinpercy robinpercy Awaiting requested review from robinpercy

Assignees

@johngmyers johngmyers

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/api cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Milestone
v1.18
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@olemarkus @k8s-ci-robot @hakman @johngmyers @rifelpet