From 1224b3a6f123b3fc50364a138814261655210027 Mon Sep 17 00:00:00 2001 From: sai chaithanya Date: Thu, 9 Sep 2021 16:27:42 +0530 Subject: [PATCH] chore(ci): updating branch reference from master to develop(HEAD) (#382) * updating branch reference from master to develop(HEAD) * updates build branch to 'develop' in github workflow * add ghcr as an additional container repository to host container images Signed-off-by: mittachaitu --- .github/workflows/build.yml | 54 ++++++++++++++++--- .github/workflows/chart-lint-test.yml | 4 +- .github/workflows/pull_request.yml | 4 +- .github/workflows/release-charts.yml | 2 +- .github/workflows/release.yml | 40 ++++++++++++++ CODE_OF_CONDUCT.md | 2 +- README.md | 4 +- build/push | 2 +- docs/developer-guide/cstor-volume.md | 2 +- docs/developer-guide/devel.md | 40 +++++++------- docs/developer-guide/start.md | 6 +-- docs/quick.md | 2 +- docs/tutorial/volumes/rwx-with-nfs.md | 2 +- docs/tutorial/volumes/volume.md | 10 ++-- docs/workload/elasticsearch/elasticsearch.md | 6 +-- .../prometheus-operator/prometheus.md | 8 +-- docs/workload/wordpress/wordpress-rwx.md | 8 +-- pkg/controllers/cspc-controller/sync.go | 2 +- 18 files changed, 139 insertions(+), 59 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 13f665de..dc3f6e02 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -17,7 +17,7 @@ on: create: push: branches: - - 'master' + - 'develop' - 'v*' paths-ignore: - 'docs/**' @@ -88,7 +88,7 @@ jobs: run: | BRANCH="${GITHUB_REF##*/}" CI_TAG=${BRANCH#v}-ci - if [ ${BRANCH} = "master" ]; then + if [ ${BRANCH} = "develop" ]; then CI_TAG="ci" fi echo "TAG=${CI_TAG}" >> $GITHUB_ENV @@ -117,7 +117,7 @@ jobs: run: | BRANCH="${GITHUB_REF##*/}" CI_TAG=${BRANCH#v}-ci - if [ ${BRANCH} = "master" ]; then + if [ ${BRANCH} = "develop" ]; then CI_TAG="ci" fi echo "TAG=${CI_TAG}" >> $GITHUB_ENV @@ -136,6 +136,7 @@ jobs: images: | ${{ env.IMAGE_ORG }}/cspc-operator quay.io/${{ env.IMAGE_ORG }}/cspc-operator + ghcr.io/${{ env.IMAGE_ORG }}/cspc-operator tag-latest: false tag-custom-only: true tag-custom: | @@ -170,6 +171,13 @@ jobs: username: ${{ secrets.QUAY_USERNAME }} password: ${{ secrets.QUAY_TOKEN }} + - name: Login to GHCR + uses: docker/login-action@v1 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + - name: Build & Push Image uses: docker/build-push-action@v2 with: @@ -202,7 +210,7 @@ jobs: run: | BRANCH="${GITHUB_REF##*/}" CI_TAG=${BRANCH#v}-ci - if [ ${BRANCH} = "master" ]; then + if [ ${BRANCH} = "develop" ]; then CI_TAG="ci" fi echo "TAG=${CI_TAG}" >> $GITHUB_ENV @@ -221,6 +229,7 @@ jobs: images: | ${{ env.IMAGE_ORG }}/cvc-operator quay.io/${{ env.IMAGE_ORG }}/cvc-operator + ghcr.io/${{ env.IMAGE_ORG }}/cvc-operator tag-latest: false tag-custom-only: true tag-custom: | @@ -255,6 +264,13 @@ jobs: username: ${{ secrets.QUAY_USERNAME }} password: ${{ secrets.QUAY_TOKEN }} + - name: Login to GHCR + uses: docker/login-action@v1 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + - name: Build & Push Image uses: docker/build-push-action@v2 with: @@ -287,7 +303,7 @@ jobs: run: | BRANCH="${GITHUB_REF##*/}" CI_TAG=${BRANCH#v}-ci - if [ ${BRANCH} = "master" ]; then + if [ ${BRANCH} = "develop" ]; then CI_TAG="ci" fi echo "TAG=${CI_TAG}" >> $GITHUB_ENV @@ -306,6 +322,7 @@ jobs: images: | ${{ env.IMAGE_ORG }}/cstor-pool-manager quay.io/${{ env.IMAGE_ORG }}/cstor-pool-manager + ghcr.io/${{ env.IMAGE_ORG }}/cstor-pool-manager tag-latest: false tag-custom-only: true tag-custom: | @@ -340,6 +357,13 @@ jobs: username: ${{ secrets.QUAY_USERNAME }} password: ${{ secrets.QUAY_TOKEN }} + - name: Login to GHCR + uses: docker/login-action@v1 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + - name: Build & Push Image uses: docker/build-push-action@v2 with: @@ -373,7 +397,7 @@ jobs: run: | BRANCH="${GITHUB_REF##*/}" CI_TAG=${BRANCH#v}-ci - if [ ${BRANCH} = "master" ]; then + if [ ${BRANCH} = "develop" ]; then CI_TAG="ci" fi echo "TAG=${CI_TAG}" >> $GITHUB_ENV @@ -392,6 +416,7 @@ jobs: images: | ${{ env.IMAGE_ORG }}/cstor-volume-manager quay.io/${{ env.IMAGE_ORG }}/cstor-volume-manager + ghcr.io/${{ env.IMAGE_ORG }}/cstor-volume-manager tag-latest: false tag-custom-only: true tag-custom: | @@ -426,6 +451,13 @@ jobs: username: ${{ secrets.QUAY_USERNAME }} password: ${{ secrets.QUAY_TOKEN }} + - name: Login to GHCR + uses: docker/login-action@v1 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + - name: Build & Push Image uses: docker/build-push-action@v2 with: @@ -458,7 +490,7 @@ jobs: run: | BRANCH="${GITHUB_REF##*/}" CI_TAG=${BRANCH#v}-ci - if [ ${BRANCH} = "master" ]; then + if [ ${BRANCH} = "develop" ]; then CI_TAG="ci" fi echo "TAG=${CI_TAG}" >> $GITHUB_ENV @@ -477,6 +509,7 @@ jobs: images: | ${{ env.IMAGE_ORG }}/cstor-webhook quay.io/${{ env.IMAGE_ORG }}/cstor-webhook + ghcr.io/${{ env.IMAGE_ORG }}/cstor-webhook tag-latest: false tag-custom-only: true tag-custom: | @@ -511,6 +544,13 @@ jobs: username: ${{ secrets.QUAY_USERNAME }} password: ${{ secrets.QUAY_TOKEN }} + - name: Login to GHCR + uses: docker/login-action@v1 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + - name: Build & Push Image uses: docker/build-push-action@v2 with: diff --git a/.github/workflows/chart-lint-test.yml b/.github/workflows/chart-lint-test.yml index e5298097..46509a24 100644 --- a/.github/workflows/chart-lint-test.yml +++ b/.github/workflows/chart-lint-test.yml @@ -5,12 +5,12 @@ on: paths: - 'deploy/helm/**' branches: - - master + - develop pull_request: paths: - 'deploy/helm/**' branches: - - master + - develop jobs: lint-test: diff --git a/.github/workflows/pull_request.yml b/.github/workflows/pull_request.yml index 1d06698c..e3f9931d 100644 --- a/.github/workflows/pull_request.yml +++ b/.github/workflows/pull_request.yml @@ -22,8 +22,8 @@ on: - 'changelogs/**' - 'CHANGELOG.md' branches: - # on pull requests to master and release branches - - master + # on pull requests to develop and release branches + - develop - 'v*' jobs: diff --git a/.github/workflows/release-charts.yml b/.github/workflows/release-charts.yml index 5e9a2583..098bc0d7 100644 --- a/.github/workflows/release-charts.yml +++ b/.github/workflows/release-charts.yml @@ -5,7 +5,7 @@ on: paths: - 'deploy/helm/**' branches: - - master + - develop jobs: release: diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 9eec3e68..558b98cb 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -51,6 +51,7 @@ jobs: images: | ${{ env.IMAGE_ORG }}/cspc-operator quay.io/${{ env.IMAGE_ORG }}/cspc-operator + ghcr.io/${{ env.IMAGE_ORG }}/cspc-operator tag-latest: true tag-semver: | {{version}} @@ -84,6 +85,13 @@ jobs: username: ${{ secrets.QUAY_USERNAME }} password: ${{ secrets.QUAY_TOKEN }} + - name: Login to GHCR + uses: docker/login-action@v1 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + - name: Build & Push Image uses: docker/build-push-action@v2 with: @@ -131,6 +139,7 @@ jobs: images: | ${{ env.IMAGE_ORG }}/cvc-operator quay.io/${{ env.IMAGE_ORG }}/cvc-operator + ghcr.io/${{ env.IMAGE_ORG }}/cvc-operator tag-latest: true tag-semver: | {{version}} @@ -164,6 +173,13 @@ jobs: username: ${{ secrets.QUAY_USERNAME }} password: ${{ secrets.QUAY_TOKEN }} + - name: Login to GHCR + uses: docker/login-action@v1 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + - name: Build & Push Image uses: docker/build-push-action@v2 with: @@ -211,6 +227,7 @@ jobs: images: | ${{ env.IMAGE_ORG }}/cstor-pool-manager quay.io/${{ env.IMAGE_ORG }}/cstor-pool-manager + ghcr.io/${{ env.IMAGE_ORG }}/cstor-pool-manager tag-latest: true tag-semver: | {{version}} @@ -244,6 +261,13 @@ jobs: username: ${{ secrets.QUAY_USERNAME }} password: ${{ secrets.QUAY_TOKEN }} + - name: Login to GHCR + uses: docker/login-action@v1 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + - name: Build & Push Image uses: docker/build-push-action@v2 with: @@ -292,6 +316,7 @@ jobs: images: | ${{ env.IMAGE_ORG }}/cstor-volume-manager quay.io/${{ env.IMAGE_ORG }}/cstor-volume-manager + ghcr.io/${{ env.IMAGE_ORG }}/cstor-volume-manager tag-latest: true tag-semver: | {{version}} @@ -325,6 +350,13 @@ jobs: username: ${{ secrets.QUAY_USERNAME }} password: ${{ secrets.QUAY_TOKEN }} + - name: Login to GHCR + uses: docker/login-action@v1 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + - name: Build & Push Image uses: docker/build-push-action@v2 with: @@ -372,6 +404,7 @@ jobs: images: | ${{ env.IMAGE_ORG }}/cstor-webhook quay.io/${{ env.IMAGE_ORG }}/cstor-webhook + ghcr.io/${{ env.IMAGE_ORG }}/cstor-webhook tag-latest: true tag-semver: | {{version}} @@ -405,6 +438,13 @@ jobs: username: ${{ secrets.QUAY_USERNAME }} password: ${{ secrets.QUAY_TOKEN }} + - name: Login to GHCR + uses: docker/login-action@v1 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + - name: Build & Push Image uses: docker/build-push-action@v2 with: diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 0acfe367..a3ee6a8a 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,3 +1,3 @@ ## Community Code of Conduct -This project follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). \ No newline at end of file +This project follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). diff --git a/README.md b/README.md index 9644e1d4..fcaa0d99 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ ## Project Status: Beta -We are always happy to list users who run cStor in production, check out our existing [adopters](https://github.com/openebs/openebs/tree/master/adopters), and their [feedbacks](https://github.com/openebs/openebs/issues/2719). +We are always happy to list users who run cStor in production, check out our existing [adopters](https://github.com/openebs/openebs/tree/HEAD/adopters), and their [feedbacks](https://github.com/openebs/openebs/issues/2719). The new cStor Operators support the following Operations on cStor pools and volumes: 1. Provisioning and De-provisioning of cStor pools. @@ -37,7 +37,7 @@ in the CSPC. A cStor pool is provisioned on node by utilising the disks attached CStorPoolInstance(CSPI) custom resource in a Kubernetes cluster. One has freedom to specify the disks that they want to use for pool provisioning. -CSPC API comes with a variety of tunables and features and the API can be viewed for [here](https://github.com/openebs/api/blob/master/pkg/apis/cstor/v1/cstorpoolcluster.go) +CSPC API comes with a variety of tunables and features and the API can be viewed for [here](https://github.com/openebs/api/blob/HEAD/pkg/apis/cstor/v1/cstorpoolcluster.go) Once a CSPC is created, cspc-operator provision CSPI CR and **pool-manager** deployment on each node where cStor pool should be created. The pool-manager deployment watches for its corresponding CSPI on the node and finally executes commands to diff --git a/build/push b/build/push index a9a4d174..b68c0fbb 100755 --- a/build/push +++ b/build/push @@ -70,7 +70,7 @@ fi # set the tag CI (fixed) and build tags. BUILD_TAG="${CURRENT_BRANCH}-${BUILD_ID}" CI_TAG="${CURRENT_BRANCH}-ci" -if [ ${CURRENT_BRANCH} = "master" ]; then +if [ ${CURRENT_BRANCH} = "develop" ]; then CI_TAG="ci" fi diff --git a/docs/developer-guide/cstor-volume.md b/docs/developer-guide/cstor-volume.md index a6c20cfe..cbcdb4ed 100644 --- a/docs/developer-guide/cstor-volume.md +++ b/docs/developer-guide/cstor-volume.md @@ -185,4 +185,4 @@ commands after reading the configuration from the CVR. ``` 8. `Node plugin` component is not shown in the above diagram to keep it simple. But the work of node plugin is to -finally make the volume available for a pod scheduled on the node by staging and publishing it. \ No newline at end of file +finally make the volume available for a pod scheduled on the node by staging and publishing it. diff --git a/docs/developer-guide/devel.md b/docs/developer-guide/devel.md index 3b0bda4b..19864275 100644 --- a/docs/developer-guide/devel.md +++ b/docs/developer-guide/devel.md @@ -27,7 +27,7 @@ git clone https://github.com/$user/cstor-operators.git cd cstor-operators git remote add upstream https://github.com/openebs/cstor-operators.git -# Never push to upstream master +# Never push to upstream develop git remote set-url --push upstream no_push # Confirm that your remotes make sense @@ -44,15 +44,15 @@ Open a terminal on your local host. Change directory to the cstor-operators-fork $ cd cstor-operators ``` - Checkout the master branch. + Checkout the develop branch. ```sh - $ git checkout master - Switched to branch 'master' - Your branch is up-to-date with 'origin/master'. + $ git checkout develop + Switched to branch 'develop' + Your branch is up-to-date with 'origin/develop'. ``` - Recall that origin/master is a branch on your remote GitHub repository. + Recall that origin/develop is a branch on your remote GitHub repository. Make sure you have the upstream remote openebs/cstor-operators by listing them. ```sh @@ -69,45 +69,45 @@ $ cd cstor-operators $ git remote add upstream https://github.com/openebs/cstor-operators.git ``` - Fetch all the changes from the upstream master branch. + Fetch all the changes from the upstream develop branch. ```sh - $ git fetch upstream master + $ git fetch upstream develop remote: Counting objects: 141, done. remote: Compressing objects: 100% (29/29), done. remote: Total 141 (delta 52), reused 46 (delta 46), pack-reused 66 Receiving objects: 100% (141/141), 112.43 KiB | 0 bytes/s, done. Resolving deltas: 100% (79/79), done. From github.com:openebs/cstor-operators - * branch master -> FETCH_HEAD + * branch develop -> FETCH_HEAD ``` - Rebase your local master with the upstream/master. + Rebase your local develop with the upstream/develop. ```sh - $ git rebase upstream/master + $ git rebase upstream/develop First, rewinding head to replay your work on top of it... - Fast-forwarded master to upstream/master. + Fast-forwarded develop to upstream/develop. ``` - This command applies all the commits from the upstream master to your local master. + This command applies all the commits from the upstream develop to your local develop. Check the status of your local branch. ```sh $ git status - On branch master - Your branch is ahead of 'origin/master' by 38 commits. + On branch develop + Your branch is ahead of 'origin/develop' by 38 commits. (use "git push" to publish your local commits) nothing to commit, working directory clean ``` - Your local repository now has all the changes from the upstream remote. You need to push the changes to your own remote fork which is origin master. + Your local repository now has all the changes from the upstream remote. You need to push the changes to your own remote fork which is origin develop. - Push the rebased master to origin master. + Push the rebased develop to origin develop. ```sh - $ git push origin master + $ git push origin develop Username for 'https://github.com': $user Password for 'https://$user@github.com': Counting objects: 223, done. @@ -115,7 +115,7 @@ $ cd cstor-operators Writing objects: 100% (69/69), 8.76 KiB | 0 bytes/s, done. Total 69 (delta 53), reused 47 (delta 31) To https://github.com/$user/cstor-operators.git - 8e107a9..5035fa1 master -> master + 8e107a9..5035fa1 develop -> develop ``` ### Create a new feature branch to work on your issue @@ -152,7 +152,7 @@ You can build amd64 images by following command. ```sh # While on your myfeature branch (see above) git fetch upstream -git rebase upstream/master +git rebase upstream/develop ``` While you rebase your changes, you must resolve any conflicts that might arise and build and test your changes using the above steps. diff --git a/docs/developer-guide/start.md b/docs/developer-guide/start.md index a7cb8488..c462def1 100644 --- a/docs/developer-guide/start.md +++ b/docs/developer-guide/start.md @@ -24,7 +24,7 @@ OpenEBS is an Apache 2.0 Licensed project and all your commits should be signed * Find an issue to work on or create a new issue. The issues are maintained at [openebs/openebs](https://github.com/openebs/openebs/issues). You can pick up from a list of [good-first-issues](https://github.com/openebs/openebs/labels/good%20first%20issue). * Claim your issue by commenting your intent to work on it to avoid duplication of efforts. * Fork the repository on GitHub. -* Create a branch from where you want to base your work (usually master). +* Create a branch from where you want to base your work (usually develop). * Make your changes. If you are working on code contributions, please see [Setting up the Development Environment](#setting-up-your-development-environment). * Relevant coding style guidelines are the [Go Code Review Comments](https://code.google.com/p/go-wiki/wiki/CodeReviewComments) and the _Formatting and style_ section of Peter Bourgon's [Go: Best Practices for Production Environments](http://peter.bourgon.org/go-in-production/#formatting-and-style). * Commit your changes by making sure the commit messages convey the need and notes about the commit. @@ -33,7 +33,7 @@ OpenEBS is an Apache 2.0 Licensed project and all your commits should be signed ## Pull Request Checklist -* Rebase to the current master branch before submitting your pull request. +* Rebase to the current develop branch before submitting your pull request. * Commits should be as small as possible. Each commit should follow the checklist below: - For code changes, add tests relevant to the fixed bug or new feature. - Pass the compile and tests - includes spell checks, formatting, etc. @@ -44,7 +44,7 @@ OpenEBS is an Apache 2.0 Licensed project and all your commits should be signed ## Sign your work -We use the Developer Certificate of Origin (DCO) as an additional safeguard for the OpenEBS project. This is a well established and widely used mechanism to assure that contributors have confirmed their right to license their contribution under the project's license. Please read [dcofile](https://github.com/openebs/openebs/blob/master/contribute/developer-certificate-of-origin). If you can certify it, then just add a line to every git commit message: +We use the Developer Certificate of Origin (DCO) as an additional safeguard for the OpenEBS project. This is a well established and widely used mechanism to assure that contributors have confirmed their right to license their contribution under the project's license. Please read [dcofile](https://github.com/openebs/openebs/blob/HEAD/contribute/developer-certificate-of-origin). If you can certify it, then just add a line to every git commit message: ``` Signed-off-by: Random J Developer diff --git a/docs/quick.md b/docs/quick.md index 7b67aeeb..93bd2a6c 100644 --- a/docs/quick.md +++ b/docs/quick.md @@ -60,7 +60,7 @@ helm install openebs-cstor openebs-cstor/cstor -n openebs --create-namespace -[Click here](https://github.com/openebs/cstor-operators/blob/master/deploy/helm/charts/README.md) for detailed instructions. +[Click here](https://github.com/openebs/cstor-operators/blob/HEAD/deploy/helm/charts/README.md) for detailed instructions. ### Using Operator: diff --git a/docs/tutorial/volumes/rwx-with-nfs.md b/docs/tutorial/volumes/rwx-with-nfs.md index eaae1858..ac8134f6 100644 --- a/docs/tutorial/volumes/rwx-with-nfs.md +++ b/docs/tutorial/volumes/rwx-with-nfs.md @@ -17,7 +17,7 @@ In this document, we will explain how you can easily set up a NFS solution using ### Prerequisites -- OpenEBS should be installed and then configure cStor operator. The steps for doing this configuration can be found [here](https://github.com/openebs/cstor-operators/blob/master/docs/quick.md). cStor configuration includes installation of cStor operator, then provisioning of a CStorPoolCluster(CSPC) and finally the creation of a StorageClass that will consume the created CSPC pool. +- OpenEBS should be installed and then configure cStor operator. The steps for doing this configuration can be found [here](https://github.com/openebs/cstor-operators/blob/HEAD/docs/quick.md). cStor configuration includes installation of cStor operator, then provisioning of a CStorPoolCluster(CSPC) and finally the creation of a StorageClass that will consume the created CSPC pool. - Install NFS client packages on all worker nodes before deploy any application with the NFS supported StorageClass. In this example, we used base OS as `Ubuntu` on all worker nodes. The `nfs-common` packages are installed on all worker nodes and then enabled the NFS service. ### Installing OpenEBS NFS Provisioner diff --git a/docs/tutorial/volumes/volume.md b/docs/tutorial/volumes/volume.md index 5c67bae1..f9428742 100644 --- a/docs/tutorial/volumes/volume.md +++ b/docs/tutorial/volumes/volume.md @@ -36,12 +36,12 @@ Depending on the OS select the appropriate deployment file. - For Ubuntu 16.04 and CentOS. ``` - kubectl apply -f https://raw.githubusercontent.com/openebs/cstor-csi/master/deploy/csi-operator.yaml + kubectl apply -f https://raw.githubusercontent.com/openebs/cstor-csi/HEAD/deploy/csi-operator.yaml ``` - For Ubuntu 18.04 ``` - kubectl apply -f https://raw.githubusercontent.com/openebs/cstor-csi/master/deploy/csi-operator-ubuntu-18.04.yaml + kubectl apply -f https://raw.githubusercontent.com/openebs/cstor-csi/HEAD/deploy/csi-operator-ubuntu-18.04.yaml ``` Verify that the OpenEBS CSI Components are installed. @@ -66,7 +66,7 @@ openebs-csi-node-56t5g 2/2 Running 0 6m13s The following command will create the specified cStor Pools in the cspc yaml: ``` - kubectl apply -f https://raw.githubusercontent.com/openebs/cstor-csi/master/examples/cspc.yaml + kubectl apply -f https://raw.githubusercontent.com/openebs/cstor-csi/HEAD/examples/cspc.yaml ``` 2. Create a Storage Class to dynamically provision volumes @@ -90,7 +90,7 @@ openebs-csi-node-56t5g 2/2 Running 0 6m13s The following file helps you to create a Storage Class using the cStor sparse pool created in the previous step. ``` - kubectl apply -f https://raw.githubusercontent.com/openebs/cstor-csi/master/examples/csi-storageclass.yaml + kubectl apply -f https://raw.githubusercontent.com/openebs/cstor-csi/HEAD/examples/csi-storageclass.yaml ``` 3. Run your application by specifying the above Storage Class for @@ -99,7 +99,7 @@ openebs-csi-node-56t5g 2/2 Running 0 6m13s The following example launches a busybox pod using a cStor Volume provisioned via CSI Provisioner. ``` - kubectl apply -f https://raw.githubusercontent.com/openebs/cstor-csi/master/examples/busybox-csi-cstor-sparse.yaml + kubectl apply -f https://raw.githubusercontent.com/openebs/cstor-csi/HEAD/examples/busybox-csi-cstor-sparse.yaml ``` Verify that the pods is running and is able to write the data. diff --git a/docs/workload/elasticsearch/elasticsearch.md b/docs/workload/elasticsearch/elasticsearch.md index aa5610a6..e37cd71f 100644 --- a/docs/workload/elasticsearch/elasticsearch.md +++ b/docs/workload/elasticsearch/elasticsearch.md @@ -67,7 +67,7 @@ Advantages of using OpenEBS for Elasticsearch database: A storage engine is the data plane component of the IO path of a Persistent Volume. In CAS architecture, users can choose different data planes for different application workloads based on a configuration policy. OpenEBS provides different types of storage engines and you should choose the right engine that suits your type of application requirements and storage available on your Kubernetes nodes. More information can be read from [here](https://docs.openebs.io/docs/next/overview.html#types-of-openebs-storage-engines). After OpenEBS installation, choose the OpenEBS storage engine as per your requirement. -- Choose **cStor**, If you are looking for replicated storage feature and other enterprise graded features such as volume expansion, backup and restore, etc. cStor configuration can be found [here](https://github.com/openebs/cstor-operators/blob/master/docs/quick.md). In this document, we will be doing Elasticsearch installation using OpenEBS cStor. +- Choose **cStor**, If you are looking for replicated storage feature and other enterprise graded features such as volume expansion, backup and restore, etc. cStor configuration can be found [here](https://github.com/openebs/cstor-operators/blob/HEAD/docs/quick.md). In this document, we will be doing Elasticsearch installation using OpenEBS cStor. - Choose **OpenEBS Local PV**, if you are not requiring replicated storage but high performance storage engine. The steps for deploying Prometheus operator using OpenEBS Local PV can be found [here](https://docs.openebs.io/docs/next/elasticsearch.html). @@ -589,8 +589,8 @@ You will see the OpenEBS NDM pod logs listed on the page. ## See Also: -### [cStor User guide](https://github.com/openebs/cstor-operators/blob/master/docs/quick.md) -### [Troubleshooting cStor](https://github.com/openebs/cstor-operators/blob/master/docs/troubleshooting/troubleshooting.md) +### [cStor User guide](https://github.com/openebs/cstor-operators/blob/HEAD/docs/quick.md) +### [Troubleshooting cStor](https://github.com/openebs/cstor-operators/blob/HEAD/docs/troubleshooting/troubleshooting.md)
diff --git a/docs/workload/prometheus-operator/prometheus.md b/docs/workload/prometheus-operator/prometheus.md index 3b745d1c..0efeae87 100644 --- a/docs/workload/prometheus-operator/prometheus.md +++ b/docs/workload/prometheus-operator/prometheus.md @@ -33,7 +33,7 @@ We will add a 100G disk to each node. These disks will be consumed by CSI based OpenEBS should be installed first on your Kubernetes cluster. The steps for OpenEBS installation can be found [here](https://docs.openebs.io/docs/next/installation.html). After OpenEBS installation, choose the OpenEBS storage engine as per your requirement. -- Choose **cStor**, If you are looking for replicated storage feature and other enterprise graded features such as volume expansion, backup and restore, etc. cStor configuration can be found [here](https://github.com/openebs/cstor-operators/blob/master/docs/quick.md). In this document, we are mentioning about the Prometheus operator installation using OpenEBS cStor. +- Choose **cStor**, If you are looking for replicated storage feature and other enterprise graded features such as volume expansion, backup and restore, etc. cStor configuration can be found [here](https://github.com/openebs/cstor-operators/blob/HEAD/docs/quick.md). In this document, we are mentioning about the Prometheus operator installation using OpenEBS cStor. - Choose **OpenEBS Local PV**, if you are not requiring replicated storage but high performance storage engine. The steps for deploying Prometheus operator using OpenEBS Local PV can be found [here](https://docs.openebs.io/docs/next/prometheus.html). ### Installing Prometheus Operator @@ -327,10 +327,10 @@ Users can upload a Grafana dashboard for Prometheus in 3 ways. ## See Also: -### [cStor User guide](https://github.com/openebs/cstor-operators/blob/master/docs/quick.md) +### [cStor User guide](https://github.com/openebs/cstor-operators/blob/HEAD/docs/quick.md) -### [Troubleshooting cStor](https://github.com/openebs/cstor-operators/blob/master/docs/troubleshooting/troubleshooting.md) +### [Troubleshooting cStor](https://github.com/openebs/cstor-operators/blob/HEAD/docs/troubleshooting/troubleshooting.md)
-
\ No newline at end of file +
diff --git a/docs/workload/wordpress/wordpress-rwx.md b/docs/workload/wordpress/wordpress-rwx.md index 739d4843..79cdad07 100644 --- a/docs/workload/wordpress/wordpress-rwx.md +++ b/docs/workload/wordpress/wordpress-rwx.md @@ -29,8 +29,8 @@ We will add a 100G disk to each node. These disks will be consumed by CSI based ### Prerequisites -- OpenEBS should be installed and then configure cStor operator. The steps for doing this configuration can be found [here](https://github.com/openebs/cstor-operators/blob/master/docs/quick.md). cStor configuration includes installation of cStor operator, then provisioning of a CStorPoolCluster(CSPC) and finally the creation of a StorageClass that will consume the created CSPC pool. -- Install OpenEBS NFS provisioner in your cluster. The steps can be found from [here](https://github.com/openebs/cstor-operators/tree/master/docs/tutorial/volumes/rwx-with-nfs.md). +- OpenEBS should be installed and then configure cStor operator. The steps for doing this configuration can be found [here](https://github.com/openebs/cstor-operators/blob/HEAD/docs/quick.md). cStor configuration includes installation of cStor operator, then provisioning of a CStorPoolCluster(CSPC) and finally the creation of a StorageClass that will consume the created CSPC pool. +- Install OpenEBS NFS provisioner in your cluster. The steps can be found from [here](https://github.com/openebs/cstor-operators/tree/HEAD/docs/tutorial/volumes/rwx-with-nfs.md). - Install NFS client packages in all worker nodes. In this example, we used base OS as Ubuntu on all worker nodes. The `nfs-common` packages are installed on all worker nodes and then enabled the NFS service. ### How to use NFS volume for different applications? @@ -101,9 +101,9 @@ pvc-99b40863-ea16-4dc8-9d54-ca5051940625 10Gi RWO Delete ## See Also: -### [cStor User guide](https://github.com/openebs/cstor-operators/blob/master/docs/quick.md) +### [cStor User guide](https://github.com/openebs/cstor-operators/blob/HEAD/docs/quick.md) -### [Troubleshooting cStor](https://github.com/openebs/cstor-operators/blob/master/docs/troubleshooting/troubleshooting.md) +### [Troubleshooting cStor](https://github.com/openebs/cstor-operators/blob/HEAD/docs/troubleshooting/troubleshooting.md) ### [OpenEBS NFS provisioner](https://github.com/openebs/dynamic-nfs-provisioner) diff --git a/pkg/controllers/cspc-controller/sync.go b/pkg/controllers/cspc-controller/sync.go index b1d2f1f6..b9fb05a8 100644 --- a/pkg/controllers/cspc-controller/sync.go +++ b/pkg/controllers/cspc-controller/sync.go @@ -505,7 +505,7 @@ defaulting mechanism is -- if certain fields are not specified in cspc at pool config level ( or per cspi level ) then a generic value from pool spec is taken. Please refer following design document to understand more -https://github.com/openebs/api/tree/master/design/cstor/v1 +https://github.com/openebs/api/tree/HEAD/design/cstor/v1 ToDo: Offload this defaulting mechanism to mutating webhook server. */