From ce0267135199a7b0cbade8d021ccbbc983900b37 Mon Sep 17 00:00:00 2001 From: fengshunli <1171313930@qq.com> Date: Tue, 16 Apr 2024 12:20:48 +0800 Subject: [PATCH] update readme ci Signed-off-by: fengshunli <1171313930@qq.com> --- .github/workflows/lint-test.yaml | 4 ++-- .github/workflows/release.yaml | 2 +- .github/workflows/superlinter.yml | 2 +- .github/workflows/sync-codeowners.yaml | 4 ++-- .github/workflows/sync-readme.yaml | 6 +++--- README.md | 24 ++++++++++++++++-------- 6 files changed, 25 insertions(+), 17 deletions(-) diff --git a/.github/workflows/lint-test.yaml b/.github/workflows/lint-test.yaml index 310ea4c..dc7fa6b 100644 --- a/.github/workflows/lint-test.yaml +++ b/.github/workflows/lint-test.yaml @@ -7,7 +7,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout Code - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 @@ -28,7 +28,7 @@ jobs: run: | changed=$(ct list-changed --config .github/linters/ct.yaml) if [[ -n "$changed" ]]; then - echo "name=changed::true" >> "$GITHUB_OUTPUT" + echo "changed=true" >> "$GITHUB_OUTPUT" fi - name: install helm unittest plugin diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 98baba8..ac6d6dc 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -11,7 +11,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout Code - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Fetch history run: git fetch --prune --unshallow diff --git a/.github/workflows/superlinter.yml b/.github/workflows/superlinter.yml index 73c7fe4..c6ce406 100644 --- a/.github/workflows/superlinter.yml +++ b/.github/workflows/superlinter.yml @@ -11,7 +11,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout Code - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 diff --git a/.github/workflows/sync-codeowners.yaml b/.github/workflows/sync-codeowners.yaml index 4d162a0..228ef78 100644 --- a/.github/workflows/sync-codeowners.yaml +++ b/.github/workflows/sync-codeowners.yaml @@ -9,11 +9,11 @@ jobs: build: runs-on: ubuntu-22.04 steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - run: | ./scripts/check-codeowners.sh > ${{ runner.temp }}/CODEOWNERS - name: Checkout Code - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: ref: master - name: install yq diff --git a/.github/workflows/sync-readme.yaml b/.github/workflows/sync-readme.yaml index 9a5071c..2063259 100644 --- a/.github/workflows/sync-readme.yaml +++ b/.github/workflows/sync-readme.yaml @@ -10,10 +10,10 @@ jobs: build: runs-on: ubuntu-22.04 steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - run: | cp -f README.md ${{ runner.temp }}/README.md - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 with: ref: gh-pages - run: | @@ -21,5 +21,5 @@ jobs: git config user.name "$GITHUB_ACTOR" git config user.email "$GITHUB_ACTOR@users.noreply.github.com" git add README.md - git commit --signoff -m "Sync README from master" + git commit --signoff -m "Sync README from main" git push diff --git a/README.md b/README.md index b116c80..8d7b8f1 100644 --- a/README.md +++ b/README.md @@ -18,13 +18,6 @@ The cubefs-helm project helps deploy a Cubefs cluster orchestrated by Kubernetes * CSI spec version 1.1.0 * Helm 3 -### Download cubefs-helm - -```shell -git clone https://github.com/cubefs/cubefs-helm -cd cubefs-helm -``` - ### Create configuration yaml file Create a `cubefs.yaml` file, and put it in a user-defined path. Suppose this is where we put it. @@ -85,7 +78,22 @@ kubectl label node component.cubefs.io/objectnode=enabled kubectl label node component.cubefs.io/csi=enabled ``` -### Deploy Cubefs cluster +### Local Deploy Cubefs cluster + +```shell +git clone https://github.com/cubefs/cubefs-helm +cd cubefs-helm +``` + +```shell +helm upgrade --install cubefs ./cubefs -f ~/cubefs.yaml -n cubefs --create-namespace +``` + +### Remote Deploy Cubefs cluster + +```shell +helm repo add cubefs https://cubefs.github.io/cubefs-helm +``` ```shell helm upgrade --install cubefs -f ~/cubefs.yaml -n cubefs --create-namespace cubefs