Skip to content

Updated docs for enabling topology #64

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

Merged
k8s-ci-robot merged 1 commit into from
Nov 2, 2018
Merged

Updated docs for enabling topology #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 19 additions & 5 deletions book/src/Setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ If you want to use the `CSIDriver` CRD and get a preview of how configuration wi
1) Ensure the feature gate is enabled with `--feature-gates=CSIDriverRegistry=true`
2) Install the `CSIDriver` CRD on the Kubernetes cluster with the following command:
```
$> kubectl create -f https://raw.githubusercontent.com/kubernetes/csi-api/master/pkg/crd/testdata/csidriver.yaml
$> kubectl create -f https://raw.githubusercontent.com/kubernetes/csi-api/master/pkg/crd/testdata/csidriver.yaml --validate=false
Copy link
Member

@vladimirvivien vladimirvivien Oct 12, 2018

Choose a reason for hiding this comment

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

Thanks for adding this. Missed it.

Copy link
Member

@saad-ali saad-ali Oct 26, 2018

Choose a reason for hiding this comment

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

We'll should archive all of this after 1.13 as a 1.12 steps and update it for 1.13.

Copy link
Contributor Author

@verult verult Oct 26, 2018

Choose a reason for hiding this comment

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

Yep after 1.13 components roll out we could do another doc pass to make sure everything is updated

```

### Listing registered CSI drivers
Expand Down Expand Up @@ -129,16 +129,16 @@ items:
Where:
- `csiDrivers` - list of CSI drivers running on the node and their properties.
- `driver` - the CSI driver that this object refers to.
- `nodeId` - the assigned identifier for the node as determined by the driver.
- `toplogykeys` - A list of topology keys assigned to the node as supported by the driver.
- `nodeID` - the assigned identifier for the node as determined by the driver.
- `topologyKeys` - A list of topology keys assigned to the node as supported by the driver.

### Enabling CSINodeInfo
If you want to use the `CSINodeInfo` CRD and get a preview of how configuration will work at runtime, do the followings:

1) Ensure the feature gate is enabled with `--feature-gates=CSIDriverRegistry=true`
1) Ensure the feature gate is enabled with `--feature-gates=CSINodeInfo=true`
2) Install the `CSINodeInfo` CRD on the Kubernetes cluster with the following command:
```
$> kubectl create -f https://raw.githubusercontent.com/kubernetes/csi-api/master/pkg/crd/testdata/csinodeinfo.yaml
$> kubectl create -f https://raw.githubusercontent.com/kubernetes/csi-api/master/pkg/crd/testdata/csinodeinfo.yaml --validate=false
```


Expand Down Expand Up @@ -224,6 +224,20 @@ by default for alpha):
--feature-gates=VolumeSnapshotDataSource=true
```

## Topology (alpha)
In order to support topology-aware dynamic provisioning mechanisms available in Kubernetes, the *external-provisioner* must have the Topology feature enabled:

```
--feature-gates=Topology=true
Copy link

@leakingtapan leakingtapan Oct 15, 2018

Choose a reason for hiding this comment

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

Im testing topology support using EBS CSI driver, doesn't seem this feature gate is required for me. And this flag is not present in kube_features.go too. Is this a real feature gate?

Copy link
Contributor Author

@verult verult Oct 16, 2018

Choose a reason for hiding this comment

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

This is a provisioner flag

```

In addition, in the *Kubernetes cluster* the `CSINodeInfo` alpha feature must be enabled (refer to the [CSINodeInfo custom resource]{csinodeinfo-custom-resource-alpha} section for more info):

```
--feature-gates=CSINodeInfo=true
```
as well as the `KubeletPluginsWatcher` beta feature (currently enabled by default).

## Archives

Please visit the [Archives](Archive.html) for setup instructions on previous versions of Kubernetes.
Expand Down
18 changes: 13 additions & 5 deletions docs/Setup.html
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

32 changes: 15 additions & 17 deletions docs/book.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

58 changes: 29 additions & 29 deletions docs/css/variables.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
/* Themes */

.ayu {
--bg: hsl(210, 25%, 8%);
--bg: #0f1419;
--fg: #c5c5c5;

--sidebar-bg: #14191f;
Expand All @@ -32,12 +32,12 @@
--theme-popup-border: #5c6773;
--theme-hover: #191f26;

--quote-bg: hsl(226, 15%, 17%);
--quote-border: hsl(226, 15%, 22%);
--quote-bg: #262933;
--quote-border: lighten(var(--quote-bg), 5%);

--table-border-color: hsl(210, 25%, 13%);
--table-header-bg: hsl(210, 25%, 28%);
--table-alternate-bg: hsl(210, 25%, 11%);
--table-border-color: lighten(var(--bg), 5%);
--table-header-bg: lighten(var(--bg), 20%);
--table-alternate-bg: lighten(var(--bg), 3%);

--searchbar-border-color: #848484;
--searchbar-bg: #424242;
Expand All @@ -50,7 +50,7 @@
}

.coal {
--bg: hsl(200, 7%, 8%);
--bg: #141617;
--fg: #98a3ad;

--sidebar-bg: #292c2f;
Expand All @@ -72,12 +72,12 @@
--theme-popup-border: #43484d;
--theme-hover: #1f2124;

--quote-bg: hsl(234, 21%, 18%);
--quote-border: hsl(234, 21%, 23%);
--quote-bg: #242637;
--quote-border: lighten(var(--quote-bg), 5%);

--table-border-color: hsl(200, 7%, 13%);
--table-header-bg: hsl(200, 7%, 28%);
--table-alternate-bg: hsl(200, 7%, 11%);
--table-border-color: lighten(var(--bg), 5%);
--table-header-bg: lighten(var(--bg), 20%);
--table-alternate-bg: lighten(var(--bg), 3%);

--searchbar-border-color: #aaa;
--searchbar-bg: #b7b7b7;
Expand All @@ -90,7 +90,7 @@
}

.light {
--bg: hsl(0, 0%, 100%);
--bg: #ffffff;
--fg: #333333;

--sidebar-bg: #fafafa;
Expand All @@ -112,12 +112,12 @@
--theme-popup-border: #cccccc;
--theme-hover: #e6e6e6;

--quote-bg: hsl(197, 37%, 96%);
--quote-border: hsl(197, 37%, 91%);
--quote-bg: #f2f7f9;
--quote-border: darken(var(--quote-bg), 5%);

--table-border-color: hsl(0, 0%, 95%);
--table-header-bg: hsl(0, 0%, 80%);
--table-alternate-bg: hsl(0, 0%, 97%);
--table-border-color: darken(var(--bg), 5%);
--table-header-bg: darken(var(--bg), 20%);
--table-alternate-bg: darken(var(--bg), 3%);

--searchbar-border-color: #aaa;
--searchbar-bg: #fafafa;
Expand All @@ -130,7 +130,7 @@
}

.navy {
--bg: hsl(226, 23%, 11%);
--bg: #161923;
--fg: #bcbdd0;

--sidebar-bg: #282d3f;
Expand All @@ -152,12 +152,12 @@
--theme-popup-border: #737480;
--theme-hover: #282e40;

--quote-bg: hsl(226, 15%, 17%);
--quote-border: hsl(226, 15%, 22%);
--quote-bg: #262933;
--quote-border: lighten(var(--quote-bg), 5%);

--table-border-color: hsl(226, 23%, 16%);
--table-header-bg: hsl(226, 23%, 31%);
--table-alternate-bg: hsl(226, 23%, 14%);
--table-border-color: lighten(var(--bg), 5%);
--table-header-bg: lighten(var(--bg), 20%);
--table-alternate-bg: lighten(var(--bg), 3%);

--searchbar-border-color: #aaa;
--searchbar-bg: #aeaec6;
Expand All @@ -170,7 +170,7 @@
}

.rust {
--bg: hsl(60, 9%, 87%);
--bg: #e1e1db;
--fg: #262625;

--sidebar-bg: #3b2e2a;
Expand All @@ -192,12 +192,12 @@
--theme-popup-border: #b38f6b;
--theme-hover: #99908a;

--quote-bg: hsl(60, 5%, 75%);
--quote-border: hsl(60, 5%, 70%);
--quote-bg: #c1c1bb;
--quote-border: darken(var(--quote-bg), 5%);

--table-border-color: hsl(60, 9%, 82%);
--table-border-color: darken(var(--bg), 5%);
--table-header-bg: #b3a497;
--table-alternate-bg: hsl(60, 9%, 84%);
--table-alternate-bg: darken(var(--bg), 3%);

--searchbar-border-color: #aaa;
--searchbar-bg: #fafafa;
Expand Down
12 changes: 10 additions & 2 deletions docs/index.html
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading