Update examples and documentation #214

msau42 · 2018-12-21T00:49:59Z

No description provided.

msau42 · 2018-12-21T00:51:07Z

@verult and @jingxu97 can you followup and improve the documentation for snapshot and topology alpha features? We should create a new alpha driver deployment config like I suggested here

README.md

docs/development.md

README.md

msau42 · 2018-12-29T01:23:37Z

Restructured and updated

davidz627 · 2019-01-04T22:14:25Z

docs/kubernetes/user-guides/snapshots.md

+2. Deploy driver to Kubernetes Cluster
+```
+$ GCE_PD_SA_DIR=/my/safe/credentials/directory    # Directory to get the service account key
+$ GCE_PD_DRIVER_VERSION=alpha                     # Driver version to deploy


are we creating a new "alpha" overlay? Right now I think dev basically serves this function(ish)

I think we should update the overlay/docs atomically so we don't have a period of time when docs say to deploy alpha but that doesn't actually do anything

yes, i want to create a separate alpha overlay that we can use for another CI test job. I will work on adding one

I decided to just put the overlay back to dev for now. With topology going beta in 1.14, it's only snapshots that is still alpha.

msau42 · 2019-01-04T22:19:40Z

/hold
until an alpha overlay is created

k8s-ci-robot · 2019-02-21T02:33:58Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: msau42

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:

~~OWNERS~~ [msau42]

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

msau42 · 2019-02-21T02:35:14Z

I'm going to wait until 1.14 is released to test and merge this.

msau42 · 2019-04-25T21:51:39Z

Updated, but still keep hold to wait until we're closer to a release

msau42 · 2019-04-30T01:16:50Z

/hold cancel
I removed adding v0.5.0 to our official release table for now so we can get the updated docs in

msau42 · 2019-04-30T01:17:04Z

/assign @davidz627

davidz627

mostly lgtm, just some small notes

davidz627 · 2019-04-30T01:43:45Z

README.md

+
+### Kubernetes Alpha Features
+
+* Snapshots: Requires K8s 1.13+ on Master and PD driver v0.3.0+


and to use the alpha overlay?

davidz627 · 2019-04-30T01:43:56Z

README.md

-To modify dependencies or versions change `./Gopkg.toml`
+### Kubernetes Beta Features
+
+* Topology: Requires K8s 1.14+ on Master and Nodes and PD driver v0.5.0+


0.5.0 not yet release

If I change it to "dev", are we going to remember to change it back?

probably not, lets leave it like this

davidz627 · 2019-04-30T01:45:25Z

docs/kubernetes/user-guides/basic.md

+# Kubernetes Basic User Guide
+This guide gives a simple example on how to provision zonal and regional PDs in single-zone and regional clusters.
+
+**Note:** Regional cluster support only available in beta starting with


maybe move/duplicate this note in the "regional PD" section

I duplicated it because you can use single-zone pds in a regional cluster too

davidz627 · 2019-05-01T00:59:03Z

/lgtm
/retest

984feece Merge pull request kubernetes-sigs#234 from siddhikhapare/csi-tools 1f7e6059 fixed broken links of testgrid dashboard de2fba88 Merge pull request kubernetes-sigs#233 from andyzhangx/andyzhangx-patch-1 cee895e1 remove windows 20H2 build since it's EOL long time ago 670bb0ef Merge pull request kubernetes-sigs#229 from marosset/fix-codespell-errors 35d5e783 Merge pull request kubernetes-sigs#219 from yashsingh74/update-registry 63473cc9 Merge pull request kubernetes-sigs#231 from coulof/bump-go-version-1.20.5 29a5c76c Merge pull request kubernetes-sigs#228 from mowangdk/chore/adopt_kubernetes_recommand_labels 8dd28211 Update cloudbuild image with go 1.20.5 1df23dba Merge pull request kubernetes-sigs#230 from msau42/prow 1f92b7e7 Add ginkgo timeout to e2e tests to help catch any stuck tests 2b8b80ea fixing some codespell errors c10b6780 Merge pull request kubernetes-sigs#227 from coulof/check-sidecar-supported-versions 72984ec0 chore: adopt kubernetes recommand label b0555351 Header bd0a10b6 typo c39d73c3 Add comments f6491af0 Script to verify EOL sidecar version 4133d1df Merge pull request kubernetes-sigs#226 from msau42/cloudbuild 8d519d23 Pin buildkit to v0.10.6 to workaround v0.11 bug with docker manifest 6e04a030 Merge pull request kubernetes-sigs#224 from msau42/cloudbuild 26fdfffd Update cloudbuild image 6613c398 Merge pull request kubernetes-sigs#223 from sunnylovestiramisu/update 0e7ae993 Update k8s image repo url 77e47cce Merge pull request kubernetes-sigs#222 from xinydev/fix-dep-version 155854b0 Fix dep version mismatch 8f839056 Merge pull request kubernetes-sigs#221 from sunnylovestiramisu/go-update 1d3f94dd Update go version to 1.20 to match k/k v1.27 e322ce5e Merge pull request kubernetes-sigs#220 from andyzhangx/fix-golint-error b74a5120 test: fix golint error 901bcb5a Update registry k8s.gcr.io -> registry.k8s.io aa61bfd0 Merge pull request kubernetes-sigs#218 from xing-yang/update_csi_driver 7563d196 Update CSI_PROW_DRIVER_VERSION to v1.11.0 a2171bef Merge pull request kubernetes-sigs#216 from msau42/process cb987826 Merge pull request kubernetes-sigs#217 from msau42/owners a11216e4 add new reviewers and remove inactive reviewers dd986754 Add step for checking builds b66c0824 Merge pull request kubernetes-sigs#214 from pohly/junit-fixes b9b6763b filter-junit.go: fix loss of testcases when parsing Ginkgo v2 JUnit d4277839 filter-junit.go: preserve system error log 38e11468 prow.sh: publish individual JUnit files as separate artifacts git-subtree-dir: release-tools git-subtree-split: 984feece4bafac3aad74deeed76a500a0c485fb1

k8s-ci-robot requested review from jingxu97 and verult December 21, 2018 00:50

k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Dec 21, 2018

davidz627 reviewed Dec 21, 2018

View reviewed changes

README.md Outdated Show resolved Hide resolved

davidz627 reviewed Dec 21, 2018

View reviewed changes

docs/development.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

msau42 force-pushed the update-docs branch 6 times, most recently from 5451925 to d8d3a72 Compare December 29, 2018 01:22

davidz627 reviewed Jan 4, 2019

View reviewed changes

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jan 4, 2019

msau42 force-pushed the update-docs branch from d8d3a72 to fa9bc64 Compare February 21, 2019 02:33

msau42 changed the title ~~Update examples and documentation~~ WIP: Update examples and documentation Feb 21, 2019

k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 21, 2019

msau42 force-pushed the update-docs branch 2 times, most recently from 349d1b3 to 2198118 Compare February 21, 2019 02:42

davidz627 added this to In progress in Snapshots to stable Mar 9, 2019

msau42 force-pushed the update-docs branch from 2198118 to 4f166d5 Compare April 25, 2019 21:50

msau42 changed the title ~~WIP: Update examples and documentation~~ Update examples and documentation Apr 25, 2019

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 Apr 25, 2019

msau42 mentioned this pull request Apr 26, 2019

Create user guides #125

Closed

msau42 force-pushed the update-docs branch from 4f166d5 to 54a23e7 Compare April 30, 2019 01:16

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 30, 2019

k8s-ci-robot assigned davidz627 Apr 30, 2019

davidz627 reviewed Apr 30, 2019

View reviewed changes

Update examples and documentation

ff59f6f

msau42 force-pushed the update-docs branch from 54a23e7 to ff59f6f Compare May 1, 2019 00:37

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 1, 2019

k8s-ci-robot merged commit 11cb039 into kubernetes-sigs:master May 1, 2019

Snapshots to stable automation moved this from In progress to Done May 1, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update examples and documentation #214

Update examples and documentation #214

msau42 commented Dec 21, 2018

msau42 commented Dec 21, 2018

msau42 commented Dec 29, 2018

davidz627 Jan 4, 2019

davidz627 Jan 4, 2019

msau42 Jan 4, 2019

msau42 Feb 21, 2019

msau42 commented Jan 4, 2019

k8s-ci-robot commented Feb 21, 2019

msau42 commented Feb 21, 2019

msau42 commented Apr 25, 2019

msau42 commented Apr 30, 2019

msau42 commented Apr 30, 2019

davidz627 left a comment

davidz627 Apr 30, 2019

davidz627 Apr 30, 2019

msau42 Apr 30, 2019

davidz627 Apr 30, 2019

davidz627 Apr 30, 2019

msau42 May 1, 2019

davidz627 commented May 1, 2019


		### Kubernetes Alpha Features

		* Snapshots: Requires K8s 1.13+ on Master and PD driver v0.3.0+

Update examples and documentation #214

Update examples and documentation #214

Conversation

msau42 commented Dec 21, 2018

msau42 commented Dec 21, 2018

msau42 commented Dec 29, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

msau42 commented Jan 4, 2019

k8s-ci-robot commented Feb 21, 2019

msau42 commented Feb 21, 2019

msau42 commented Apr 25, 2019

msau42 commented Apr 30, 2019

msau42 commented Apr 30, 2019

davidz627 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

davidz627 commented May 1, 2019