Add configuration docs for API restrictions #24968
Conversation
joestringer
added
the
release-note/misc
maintainer-s-little-helper
bot
added
dont-merge/needs-release-note-label
joestringer
force-pushed
the
pr/joe/api-restrictions-doc
branch
from
82724e4 to
eb55a48
Compare
joestringer
force-pushed
the
pr/joe/api-restrictions-doc
branch
from
eb55a48 to
09f9732
Compare
|
/test |
joestringer
force-pushed
the
pr/joe/api-restrictions-doc
branch
from
09f9732 to
c1c16bf
Compare
|
/test EDIT: net-next job hit #23175 Job 'Cilium-PR-K8s-1.24-kernel-5.4' failed: Click to show.Test NameFailure OutputJenkins URL: https://jenkins.cilium.io/job/Cilium-PR-K8s-1.24-kernel-5.4/156/ If it is a flake and a GitHub issue doesn't already exist to track it, comment Then please upload the Jenkins artifacts to that issue. |
There was a problem hiding this comment.
@joestringer Good work. 👍🏻 Some things to work in here and in future PRs:
- Use active voice
- Address the user as "you"
- Use present tense
| DeleteEndpointID Deletes the endpoint specified by the ID. Deletion is | ||
| imminent and atomic, if the deletion request is valid and | ||
| the endpoint exists, deletion will occur even if errors are | ||
| encountered in the process. If errors have been encountered, | ||
| the code 202 will be returned, otherwise 200 on success. All | ||
| resources associated with the endpoint will be freed and the | ||
| workload represented by the endpoint will be disconnected.It | ||
| will no longer be able to initiate or receive communications | ||
| of any sort. |
There was a problem hiding this comment.
Edits for clarity, use present tense
| DeleteEndpointID Deletes the endpoint specified by the ID. Deletion is | |
| imminent and atomic, if the deletion request is valid and | |
| the endpoint exists, deletion will occur even if errors are | |
| encountered in the process. If errors have been encountered, | |
| the code 202 will be returned, otherwise 200 on success. All | |
| resources associated with the endpoint will be freed and the | |
| workload represented by the endpoint will be disconnected.It | |
| will no longer be able to initiate or receive communications | |
| of any sort. | |
| DeleteEndpointID Deletes the endpoint specified by the ID. Deletion is | |
| imminent and atomic: if the deletion request is valid and | |
| the endpoint exists, deletion occurs even if errors are | |
| encountered in the process. If errors are encountered, | |
| HTTP code 202 is returned, otherwise 200 returns on success. Upon deletion, | |
| all resources associated with the endpoint are freed and the | |
| workload represented by the endpoint is disconnected. The endpoint | |
| is no longer able to initiate or receive communications | |
| of any sort. |
| DeleteFqdnCache Deletes matching DNS lookups from the cache, optionally | ||
| restricted by DNS name. The removed IP data will no longer | ||
| be used in generated policies. |
There was a problem hiding this comment.
clarity, present tense
| DeleteFqdnCache Deletes matching DNS lookups from the cache, optionally | |
| restricted by DNS name. The removed IP data will no longer | |
| be used in generated policies. | |
| DeleteFqdnCache Deletes the matching DNS lookups from the cache, optionally | |
| restricted by DNS name. The removed IP data is no longer | |
| used in generated policies. |
| GetBGPPeers Retrieves current operational state of BGP peers created by | ||
| Cilium BGP virtual router. This includes session state, | ||
| uptime, information per address family, etc. |
There was a problem hiding this comment.
clarity, no Latin abbreviations
| GetBGPPeers Retrieves current operational state of BGP peers created by | |
| Cilium BGP virtual router. This includes session state, | |
| uptime, information per address family, etc. | |
| GetBGPPeers Retrieves the current operational state of BGP peers created by | |
| the Cilium BGP virtual router. This includes session state, | |
| uptime, information per address family, and others. |
| GetEndpoint Retrieves a list of endpoints that have metadata matching | ||
| the provided parameters, or all endpoints if no parameters | ||
| provided. | ||
| GetEndpointID Returns endpoint information |
There was a problem hiding this comment.
Use periods consistently
| GetEndpointID Returns endpoint information | |
| GetEndpointID Returns endpoint information. |
| GetIP Retrieves a list of IPs with known associated information | ||
| such as their identities, host addresses, Kubernetes pod | ||
| names, etc. The list can optionally filtered by a CIDR IP | ||
| range. |
There was a problem hiding this comment.
No Latin abbreviations
| GetIP Retrieves a list of IPs with known associated information | |
| such as their identities, host addresses, Kubernetes pod | |
| names, etc. The list can optionally filtered by a CIDR IP | |
| range. | |
| GetIP Retrieves a list of IPs with known associated information | |
| such as their identities, host addresses, Kubernetes pod | |
| names, and others. The list can optionally filtered by a CIDR IP | |
| range. |
| PatchPrefilter - | ||
| PostIPAM - | ||
| PostIPAMIP - | ||
| PutEndpointID Creates a new endpoint |
There was a problem hiding this comment.
Use periods consistently
| PutEndpointID Creates a new endpoint | |
| PutEndpointID Creates a new endpoint. |
| ===================== ==================== | ||
| Flag Name Description | ||
| ===================== ==================== | ||
| GetHealthz This path will return the status of cilium operator |
There was a problem hiding this comment.
Use present tense, clarity
| GetHealthz This path will return the status of cilium operator | |
| GetHealthz This path returns the status of the cilium operator |
|
Thanks for the feedback @zacharysarah . I've applied all of the suggestions in the new text. For the suggestions in |
joestringer
force-pushed
the
pr/joe/api-restrictions-doc
branch
from
c1c16bf to
72a607f
Compare
There was a problem hiding this comment.
@joestringer Thanks for your patience and sorry for the long delay. LGTM from a docs perspective.
Add these to all PATCH/POST/PUT/DELETE APIs. Signed-off-by: Joe Stringer <[email protected]>
This was generated by running "make generate-api" and "make generate-health-api". Signed-off-by: Joe Stringer <[email protected]>
This new tool can generate tables with the details about the new flag options that can be used to administratively enable select APIs. Signed-off-by: Joe Stringer <[email protected]>
Co-authored-by: Sarah Corleissen <[email protected]> Signed-off-by: Joe Stringer <[email protected]>
joestringer
force-pushed
the
pr/joe/api-restrictions-doc
branch
from
72a607f to
60dc52f
Compare
|
Half of CI (jenkins part) triggered automatically, so I guess I'll trigger the rest. |
|
/ci-e2e |
|
/ci-l4lb |
|
/ci-multicluster |
|
/ci-awscni |
|
/ci-eks |
|
/ci-verifier |
|
/ci-external-workloads |
|
/mlh new-flake Cilium-PR-K8s-1.24-kernel-5.4 👍 created #25721 |
|
/test-1.24-5.4 Job 'Cilium-PR-K8s-1.24-kernel-5.4' failed: Click to show.Test NameFailure OutputJenkins URL: https://jenkins.cilium.io/job/Cilium-PR-K8s-1.24-kernel-5.4/187/ If it is a flake and a GitHub issue doesn't already exist to track it, comment Then please upload the Jenkins artifacts to that issue. |
|
k8s-1.24-kernel-5.4 (test-1.24-5.4) failure is #24514 |
|
/test-1.24-5.4 |
maintainer-s-little-helper
bot
added
the
ready-to-merge
Requires:
#24967,#25009This is the documentation update corresponding to #25009.
The following commits are new:
This PR is quite big, but primarily due to the auto-generated second commit which is primarily included in order to update this page: https://docs.cilium.io/en/v1.13/api/#api-ref .