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

storage: CSI inline volumes in beta #15705

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion content/en/docs/concepts/storage/volumes.md
Original file line number Diff line number Diff line change
Expand Up @@ -1316,6 +1316,7 @@ Learn how to
#### CSI ephemeral volumes

{{< feature-state for_k8s_version="v1.15" state="alpha" >}}
{{< feature-state for_k8s_version="v1.16" state="beta" >}}
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: You could remove line 1318 as the feature is now beta.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Same here: I find history important.

Copy link
Contributor

Choose a reason for hiding this comment

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

@pohly They can always reference command-line-tools-reference/feature-gates.md for 1.15 state.

Copy link
Contributor

Choose a reason for hiding this comment

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

hello @pohly. The best place to record the state and history of a feature/feature gate is the feature gates reference page. If needed, you could link to the reference page. I think the feature-state shortcode is typically used to label the current state of the feature.

Copy link
Member

Choose a reason for hiding this comment

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

The k8s.io site has a toggle for release (or 1.14, 1.15, etc) right?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes

Copy link
Contributor Author

@pohly pohly Sep 9, 2019

Choose a reason for hiding this comment

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

I removed the line for alpha in 1.15.


This feature allows CSI volumes to be directly embedded in the Pod specification instead of a PersistentVolume. Volumes specified in this way are ephemeral and do not persist across Pod restarts.

Expand All @@ -1342,7 +1343,9 @@ spec:
foo: bar
```

This feature requires CSIInlineVolume feature gate to be enabled:
This feature requires CSIInlineVolume feature gate to be enabled. It
is enabled by default in Kubernetes >= 1.16. In Kubernetes v1.15, it
Copy link
Contributor

Choose a reason for hiding this comment

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

@pohly , is line 1346 required, as the default is enabled for v1.16?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Personally I prefer to keep the information about older releases if it doesn't get too long, because then users don't need to run a mental diff against older documentation to figure out the history. Some people have to work with more than just one release of Kubernetes, so that history is relevant.

That this feature gate exists is also relevant, regardless of the history and whether its enabled or disabled by default.

Copy link
Contributor

Choose a reason for hiding this comment

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

@pohly I agree with @kbhawkey on this. Saying "It
is enabled by default in Kubernetes >= 1.16" already explains it is not enabled by default in previous releases.

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 assume future releases of the documentation will still have that paragraph. With that in mind I changed the second sentence to "It is enabled by default starting with Kubernetes 1.16.".

The alternative, "It is enabled by default in Kubernetes 1.16", would look weird in documentation for Kubernetes 1.17...

Copy link
Contributor

Choose a reason for hiding this comment

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

@pohly Thanks for jumping on this. Looks like the change you mentioned It is enabled by default starting with Kubernetes 1.16 is not yet in the doc.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh, sorry, forgot the final git push. It's there now.

has to be enabled explicitly:

```
--feature-gates=CSIInlineVolume=true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,8 @@ different Kubernetes components.
| `CSIBlockVolume` | `true` | Beta | 1.14 | |
| `CSIDriverRegistry` | `false` | Alpha | 1.12 | 1.13 |
| `CSIDriverRegistry` | `true` | Beta | 1.14 | |
| `CSIInlineVolume` | `false` | Alpha | 1.15 | - |
| `CSIInlineVolume` | `false` | Alpha | 1.15 | 1.15 |
| `CSIInlineVolume` | `true` | Beta | 1.16 | - |
| `CSIMigration` | `false` | Alpha | 1.14 | |
| `CSIMigrationAWS` | `false` | Alpha | 1.14 | |
| `CSIMigrationAzureDisk` | `false` | Alpha | 1.15 | |
Expand Down