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 feature annotations to the reference page #759

Merged
merged 3 commits into from
Nov 6, 2024

Conversation

berkayoz
Copy link
Member

Add feature annotations to the reference page

Copy link
Contributor

Hi, looks like pyspelling job found some issues, you can check it here

@berkayoz berkayoz marked this pull request as ready for review October 23, 2024 12:03
@berkayoz berkayoz requested a review from a team as a code owner October 23, 2024 12:03
Copy link
Contributor

Hi, looks like pyspelling job found some issues, you can check it here

Copy link
Contributor

@louiseschmidtgen louiseschmidtgen left a comment

Choose a reason for hiding this comment

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

Thanks Berkay! Little nits in the comments

docs/src/snap/reference/annotations.md Outdated Show resolved Hide resolved
| `k8sd/v1alpha1/calico/autodetection-v6/canReach` | Enable IP auto-detection based on which source address on the node is used to reach the specified IP or domain. | string |
| `k8sd/v1alpha1/calico/autodetection-v6/cidrs` | Enable IP auto-detection based on which addresses on the nodes are within one of the provided CIDRs. | []string (comma separated) |
| `k8sd/v1alpha1/cilium/devices` | List of devices facing cluster/external network (used for BPF NodePort, BPF masquerading and host firewall); supports `+` as wildcard in device name, e.g. `eth+` | string |
| `k8sd/v1alpha1/cilium/direct-routing-device` | Device name used to connect nodes in direct routing mode (used by BPF NodePort, BPF host routing; if empty, automatically set to a device with k8s InternalIP/ExternalIP or with a default route bridge type devices are ignored in automatic selection | string |
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
| `k8sd/v1alpha1/cilium/direct-routing-device` | Device name used to connect nodes in direct routing mode (used by BPF NodePort, BPF host routing; if empty, automatically set to a device with k8s InternalIP/ExternalIP or with a default route bridge type devices are ignored in automatic selection | string |
| `k8sd/v1alpha1/cilium/direct-routing-device` | Device name used to connect nodes in direct routing mode (used by BPF NodePort, BPF host routing. If the flag is undefined, device name is automatically set to a device with k8s InternalIP/ExternalIP or to a default route bridge. Type devices are ignored in automatic selection | string |

This doesn't flow quite right, maybe re-word it to something like this:

Copy link
Member Author

Choose a reason for hiding this comment

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

This is from the upstream docs, seems like I messed up the formatting should be better now

docs/src/snap/reference/annotations.md Outdated Show resolved Hide resolved
---------

Co-authored-by: Louise K. Schmidtgen <[email protected]>
Copy link
Contributor

Hi, looks like pyspelling job found some issues, you can check it here

@eaudetcobello
Copy link
Contributor

I think you're missing k8sd/v1alpha1/csrsigning/auto-approve ?

Copy link
Contributor

Hi, looks like pyspelling job found some issues, you can check it here

Copy link
Contributor

@louiseschmidtgen louiseschmidtgen left a comment

Choose a reason for hiding this comment

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

Last comment on formatting:

@@ -8,6 +8,28 @@ the bootstrap configuration.
|---------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|
| `k8sd/v1alpha/lifecycle/skip-cleanup-kubernetes-node-on-remove` | If set, only microcluster and file cleanup are performed. This is helpful when an external controller (e.g., CAPI) manages the Kubernetes node lifecycle. By default, k8sd will remove the Kubernetes node when it is removed from the cluster. | "true"\|"false" |
| `k8sd/v1alpha/lifecycle/skip-stop-services-on-remove` | If set, the k8s services will not be stopped on the leaving node when removing the node. This is helpful when an external controller (e.g., CAPI) manages the Kubernetes node lifecycle. By default, all services are stopped on leaving nodes. | "true"\|"false" |
| `k8sd/v1alpha1/csrsigning/auto-approve` | If set, certificate signing requests created by worker nodes are auto approved. | "true"\|"false" |
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe @evilnick / @nhennigan can we change the width of the Description column it renders quite oddly:
image

Copy link
Contributor

Choose a reason for hiding this comment

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

Will take a look but maybe a table isn't the best option here

@berkayoz berkayoz merged commit c871eb9 into main Nov 6, 2024
6 checks passed
@berkayoz berkayoz deleted the KU-1915/update-annotations-reference branch November 6, 2024 12:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants