!6 k8s Agent for DevStar DevContainer

* DELETE /api/devcontainer?repoId=${repoId} 删除 DevContainer * refactor * GET /api/devcontainer?repoId=${repoId}&wait=true 阻塞式等待打开就绪的 DevContainer * POST /api/devcontainer 创建 DevContainer * refactored the code * Updated context usage with cancel function * 预留接口，适配单机版 DevStar DevContainer * bugFix: context canceled while deleting k8s CRD DevcontainerApp * 用户界面删除 k8s CRD DevContainer * 用户界面创建 DevContainer 并更新 NodePort * 完成用户界面创建 DevContainer * transplant test code into DevStar Studio * refactored API router to /routers/api * 更改 DevContainer Doc * 更改 DevContainer namespace * 特殊仓库重定向 * [Doc] 更新 Kubernetes 部署 DevStar Studio 文档说明，特别是 namespace 管理 * [Doc] 更新 CI脚本说明 * Revert "optimized CI workflow" * optimized CI workflow * fix typo * [feature test]: 测试 Pod 内使用 Kubernetes Operator 功能 * [Optimization] error msg for archived repo * [Optimization]: display detailed err msg on creating devContainer for …
2024-09-30 06:48:01 +00:00
parent fada46777a
commit 4b6f1b9cb5
76 changed files with 2714 additions and 248 deletions
--- a/.gitea/workflows/devstar-studio-ci.yaml
+++ b/.gitea/workflows/devstar-studio-ci.yaml
@@ -6,10 +6,16 @@
 # Add variables of Remote Git Repository Panel:
 #   - ${{ vars.DOCKER_REGISTRY_ADDRESS }}:     the address for Docker Registry
 #   - ${{ vars.DOCKER_REPOSITORY_ARTIFACT}}:   the artifact $name:$version, e.g., `devstar/devstar-studio:latest-rootless`
-#   - ${{ vars.K8S_NAMESPACE }}:               the namespace defined in Helm Chart
-#   - ${{ vars.K8S_DEPLOYMENT_NAME}}:          the Deployment to rolled out restart after pushing artifact to Docker Registry

-# Note: the actual artifact name for `master` branch: ${{ vars.DOCKER_REPOSITORY_ARTIFACT}}-build-${{ gitea.sha }}
+# Artifact命名规则： ${{ vars.DOCKER_REPOSITORY_ARTIFACT}}-build-${{ gitea.sha }}, e.g., www.devstar.cn/devstar/devstar-studio:rootless-build-0047d315a3f73cca0c18c641d24b0347456618d5
+#   DOCKER_REPOSITORY_ARTIFACT = www.devstar.cn/devstar/devstar-studio:rootless，表示 Artifact 名称
+#   build 表示分支类别：正式发行分支
+#   ${{ gitea.sha }} 表示触发 CI Workflow 的 commit SHA
+
+# 特别注意：如果使用 devstar.cn 作为 Docker Registry，需要设置 Gitea Actions Runner 变量 DOCKER_REGISTRY_ADDRESS = www.devstar.cn，若没有www前缀会导致上传失败（Ingress重定向规则导致，暂时无解）
+#  上传 Artifact 必须加上 www前缀，而拉取时不需要加 www 前缀，例如：
+#    上传前 artifact 名称： docker push  www.devstar.cn/devstar/devstar-studio:rootless-build-0047d315a3f73cca0c18c641d24b0347456618d5
+#    拉取 artifact 只需要： docker pull      devstar.cn/devstar/devstar-studio:rootless-build-0047d315a3f73cca0c18c641d24b0347456618d5

 name: DevStar Studio CI Pipeline - master branch
 on:
--- a/.gitea/workflows/devstar-studio-dev-ci.yaml
+++ b/.gitea/workflows/devstar-studio-dev-ci.yaml
@@ -6,10 +6,16 @@
 # Add variables of Remote Git Repository Panel:
 #   - ${{ vars.DOCKER_REGISTRY_ADDRESS }}:     the address for Docker Registry
 #   - ${{ vars.DOCKER_REPOSITORY_ARTIFACT}}:   the artifact $name:$version, e.g., `devstar/devstar-studio:rootless`
-#   - ${{ vars.K8S_NAMESPACE }}:               the namespace defined in Helm Chart
-#   - ${{ vars.K8S_DEPLOYMENT_NAME}}:          the Deployment to rolled out restart after pushing artifact to Docker Registry

-# Note: the actual artifact name for `dev` branch: ${{ vars.DOCKER_REPOSITORY_ARTIFACT}}-dev-${{ gitea.sha }}
+# Artifact命名规则： ${{ vars.DOCKER_REPOSITORY_ARTIFACT}}-dev-${{ gitea.sha }}, e.g., www.devstar.cn/devstar/devstar-studio:rootless-dev-0047d315a3f73cca0c18c641d24b0347456618d5
+#   DOCKER_REPOSITORY_ARTIFACT = www.devstar.cn/devstar/devstar-studio:rootless，表示 Artifact 名称
+#   dev 表示分支类别：临时开发分支
+#   ${{ gitea.sha }} 表示触发 CI Workflow 的 commit SHA
+
+# 特别注意：如果使用 devstar.cn 作为 Docker Registry，需要设置 Gitea Actions Runner 变量 DOCKER_REGISTRY_ADDRESS = www.devstar.cn，若没有www前缀会导致上传失败（Ingress重定向规则导致，暂时无解）
+#  上传 Artifact 必须加上 www前缀，而拉取时不需要加 www 前缀，例如：
+#    上传前 artifact 名称： docker push  www.devstar.cn/devstar/devstar-studio:rootless-dev-0047d315a3f73cca0c18c641d24b0347456618d5
+#    拉取 artifact 只需要： docker pull      devstar.cn/devstar/devstar-studio:rootless-dev-0047d315a3f73cca0c18c641d24b0347456618d5

 name: DevStar Studio CI Pipeline - dev branch
 on:
--- a/.gitea/workflows/devstar-studio-feature-k8s-operator-ci.yaml
+++ b/.gitea/workflows/devstar-studio-feature-k8s-operator-ci.yaml
@@ -0,0 +1,66 @@
+#
+# Add secrets of Remote Git Repository Panel:
+#   - ${{ secrets.DOCKER_REGISTRY_USERNAME }}: username of Docker Registry
+#   - ${{ secrets.DOCKER_REGISTRY_PASSWORD }}: password corresponding to the Docker Registry username
+
+# Add variables of Remote Git Repository Panel:
+#   - ${{ vars.DOCKER_REGISTRY_ADDRESS }}:     the address for Docker Registry
+#   - ${{ vars.DOCKER_REPOSITORY_ARTIFACT}}:   the artifact $name:$version, e.g., `devstar/devstar-studio:rootless`
+
+# Artifact命名规则： ${{ vars.DOCKER_REPOSITORY_ARTIFACT}}-feature-${{ gitea.sha }}, e.g., www.devstar.cn/devstar/devstar-studio:rootless-feature-0047d315a3f73cca0c18c641d24b0347456618d5
+#   DOCKER_REPOSITORY_ARTIFACT = www.devstar.cn/devstar/devstar-studio:rootless，表示 Artifact 名称
+#   feature 表示分支类别：临时测试分支
+#   ${{ gitea.sha }} 表示触发 CI Workflow 的 commit SHA
+
+# 特别注意：如果使用 devstar.cn 作为 Docker Registry，需要设置 Gitea Actions Runner 变量 DOCKER_REGISTRY_ADDRESS = www.devstar.cn，若没有www前缀会导致上传失败（Ingress重定向规则导致，暂时无解）
+#  上传 Artifact 必须加上 www前缀，而拉取时不需要加 www 前缀，例如：
+#    上传前 artifact 名称： docker push  www.devstar.cn/devstar/devstar-studio:rootless-feature-0047d315a3f73cca0c18c641d24b0347456618d5
+#    拉取 artifact 只需要： docker pull      devstar.cn/devstar/devstar-studio:rootless-feature-0047d315a3f73cca0c18c641d24b0347456618d5
+
+# k8s Operator 功能临时测试 CI脚本（正式发行版不应该有此文件）
+
+name: DevStar Studio CI Pipeline - branch feature-k8s-operator-agent
+on:
+  push:
+    branches:
+      - feature-k8s-operator-agent
+
+jobs:
+  build-and-push-x86-64-docker-image:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 🔍 Check out repository code
+        uses: actions/checkout@v4
+        with:
+          ref: feature-k8s-operator-agent
+      - name: 🔧 Test Codes and Build an Artifact
+        run: |
+          echo "Prepare to build repository code ${{ gitea.repository }}:${{ gitea.ref }}."
+          make docker
+      - name: 🚀 Push Artifact to Docker Registry
+        run: |
+          docker tag devstar-studio:latest ${{ vars.DOCKER_REGISTRY_ADDRESS }}/${{ vars.DOCKER_REPOSITORY_ARTIFACT}}-feature-${{ gitea.sha }}
+          echo "${{ secrets.DOCKER_REGISTRY_PASSWORD }}" | docker login -u ${{ secrets.DOCKER_REGISTRY_USERNAME }} ${{ vars.DOCKER_REGISTRY_ADDRESS }} --password-stdin
+          docker push ${{ vars.DOCKER_REGISTRY_ADDRESS }}/${{ vars.DOCKER_REPOSITORY_ARTIFACT}}-feature-${{ gitea.sha }}
+      - name: 🍏 Job Status Report
+        run: |
+          echo "🍏 This job's status is ${{ job.status }}."
+          echo "Output Artifact: ${{ vars.DOCKER_REGISTRY_ADDRESS }}/${{ vars.DOCKER_REPOSITORY_ARTIFACT}}-feature-${{ gitea.sha }}"
+
+
+#
+# P.S.:
+################################################################################
+# 1. How to config runner:
+#  $ docker run \
+#      --name gitea-act-runner-repo-devstar-studio \
+#      -d \
+#      -e GITEA_INSTANCE_URL=https://www.devstar.cn \
+#      -e GITEA_RUNNER_REGISTRATION_TOKEN=${YOUR_GITEA_RUNNER_REGISTRATION_TOKEN} \
+#      -v /var/run/docker.sock:/var/run/docker.sock \
+#      gitea/act_runner:latest
+#
+# 2. To clean the docker cache:
+#  $  docker builder prune --force
+#  $  if [ "$(docker volume ls -qf dangling=true)" ]; then docker volume rm $(docker volume ls -qf dangling=true); fi
+#