From d1b1631f69ca69328d95e1c35b585cff60f4ddaa Mon Sep 17 00:00:00 2001 From: Haitao Pan Date: Mon, 24 Mar 2025 20:49:38 +0800 Subject: [PATCH] merged: observability, aigc_app_engine, containerd_platform, micro_service, sso_identity_provider, devops --- .gitmodules | 0 .../.github/workflows/build-chart.yaml | 149 ++++ .../workflows/iac-pipeline-destroy.yml | 199 ++++++ .../.github/workflows/pipeline.yml | 555 ++++++++++++++ .../.github/workflows/setup-agent.yaml | 112 +++ .../.github/workflows/setup-server.yaml | 70 ++ Solutions/Observability/.gitmodules | 6 + Solutions/Observability/LICENSE | 674 ++++++++++++++++++ Solutions/Observability/README.md | 117 +++ Solutions/Observability/docs/class-statu.uml | 39 + .../docs/monitor-system-State-Diagram.uml | 65 ++ .../example/deploy/alpine-tools.yaml | 24 + .../example/deploy/deployment.yaml | 62 ++ .../Observability/example/deploy/ingress.yaml | 85 +++ .../Observability/example/deploy/service.yaml | 22 + .../example/deploy/setup-ClickHouse.sh | 20 + .../example/deploy/setup-NebulaGraph.sh | 41 ++ .../example/deploy/setup-Neo4j.sh | 28 + .../example/deploy/setup-ingress.sh | 55 ++ .../Observability/example/yaml/ingress.yaml | 111 +++ .../example/yaml/mirrors-oss-deploy.yaml | 91 +++ .../Observability/example/yaml/nginx-cm.yaml | 18 + .../example/yaml/nginx-svc-patch.yaml | 12 + .../example/yaml/photoprism/ingress.yaml | 111 +++ .../yaml/photoprism/photoprism-deploy.yaml | 128 ++++ .../yaml/photoprism/update-nginx-tls.sh | 11 + .../example/yaml/pigallery2-deploy.yaml | 147 ++++ .../example/yaml/rennew-svc-ink.sh | 29 + .../example/yaml/rennew-svc-plus.sh | 29 + .../Observability/example/yaml/rennew.sh | 29 + Solutions/Observability/example/yaml/setup.sh | 20 + .../example/yaml/update-nginx-tls.sh | 11 + .../Observability/example/yaml/vaules.yaml | 12 + Solutions/aigc_app_engine | 1 + .../workflows/iac-pipeline-destroy.yml | 199 ++++++ .../.github/workflows/pipeline.yaml | 133 ++++ .../.github/workflows/pipeline.yml | 360 ++++++++++ Solutions/containerd_platform/.gitmodules | 6 + Solutions/containerd_platform/LICENSE | 674 ++++++++++++++++++ Solutions/containerd_platform/README.md | 41 ++ .../workflows/iac-pipeline-destroy.yml | 199 ++++++ .../devops/.github/workflows/pipeline.yml | 360 ++++++++++ Solutions/devops/.gitmodules | 6 + Solutions/devops/LICENSE | 674 ++++++++++++++++++ Solutions/devops/README.md | 96 +++ Solutions/micro_service | 1 + .../workflows/iac-pipeline-destroy.yml | 199 ++++++ .../.github/workflows/pipeline.yml | 354 +++++++++ Solutions/sso_identity_provider/.gitmodules | 6 + Solutions/sso_identity_provider/LICENSE | 674 ++++++++++++++++++ Solutions/sso_identity_provider/README.md | 41 ++ 51 files changed, 7106 insertions(+) create mode 100644 .gitmodules create mode 100644 Solutions/Observability/.github/workflows/build-chart.yaml create mode 100644 Solutions/Observability/.github/workflows/iac-pipeline-destroy.yml create mode 100644 Solutions/Observability/.github/workflows/pipeline.yml create mode 100644 Solutions/Observability/.github/workflows/setup-agent.yaml create mode 100644 Solutions/Observability/.github/workflows/setup-server.yaml create mode 100644 Solutions/Observability/.gitmodules create mode 100644 Solutions/Observability/LICENSE create mode 100644 Solutions/Observability/README.md create mode 100644 Solutions/Observability/docs/class-statu.uml create mode 100644 Solutions/Observability/docs/monitor-system-State-Diagram.uml create mode 100644 Solutions/Observability/example/deploy/alpine-tools.yaml create mode 100644 Solutions/Observability/example/deploy/deployment.yaml create mode 100644 Solutions/Observability/example/deploy/ingress.yaml create mode 100644 Solutions/Observability/example/deploy/service.yaml create mode 100644 Solutions/Observability/example/deploy/setup-ClickHouse.sh create mode 100644 Solutions/Observability/example/deploy/setup-NebulaGraph.sh create mode 100644 Solutions/Observability/example/deploy/setup-Neo4j.sh create mode 100644 Solutions/Observability/example/deploy/setup-ingress.sh create mode 100644 Solutions/Observability/example/yaml/ingress.yaml create mode 100644 Solutions/Observability/example/yaml/mirrors-oss-deploy.yaml create mode 100644 Solutions/Observability/example/yaml/nginx-cm.yaml create mode 100644 Solutions/Observability/example/yaml/nginx-svc-patch.yaml create mode 100644 Solutions/Observability/example/yaml/photoprism/ingress.yaml create mode 100644 Solutions/Observability/example/yaml/photoprism/photoprism-deploy.yaml create mode 100644 Solutions/Observability/example/yaml/photoprism/update-nginx-tls.sh create mode 100644 Solutions/Observability/example/yaml/pigallery2-deploy.yaml create mode 100644 Solutions/Observability/example/yaml/rennew-svc-ink.sh create mode 100644 Solutions/Observability/example/yaml/rennew-svc-plus.sh create mode 100644 Solutions/Observability/example/yaml/rennew.sh create mode 100644 Solutions/Observability/example/yaml/setup.sh create mode 100644 Solutions/Observability/example/yaml/update-nginx-tls.sh create mode 100644 Solutions/Observability/example/yaml/vaules.yaml create mode 160000 Solutions/aigc_app_engine create mode 100644 Solutions/containerd_platform/.github/workflows/iac-pipeline-destroy.yml create mode 100644 Solutions/containerd_platform/.github/workflows/pipeline.yaml create mode 100644 Solutions/containerd_platform/.github/workflows/pipeline.yml create mode 100644 Solutions/containerd_platform/.gitmodules create mode 100644 Solutions/containerd_platform/LICENSE create mode 100644 Solutions/containerd_platform/README.md create mode 100644 Solutions/devops/.github/workflows/iac-pipeline-destroy.yml create mode 100644 Solutions/devops/.github/workflows/pipeline.yml create mode 100644 Solutions/devops/.gitmodules create mode 100644 Solutions/devops/LICENSE create mode 100644 Solutions/devops/README.md create mode 160000 Solutions/micro_service create mode 100644 Solutions/sso_identity_provider/.github/workflows/iac-pipeline-destroy.yml create mode 100644 Solutions/sso_identity_provider/.github/workflows/pipeline.yml create mode 100644 Solutions/sso_identity_provider/.gitmodules create mode 100644 Solutions/sso_identity_provider/LICENSE create mode 100644 Solutions/sso_identity_provider/README.md diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 00000000..e69de29b diff --git a/Solutions/Observability/.github/workflows/build-chart.yaml b/Solutions/Observability/.github/workflows/build-chart.yaml new file mode 100644 index 00000000..fb63aa96 --- /dev/null +++ b/Solutions/Observability/.github/workflows/build-chart.yaml @@ -0,0 +1,149 @@ +name: Build Chart + +on: + pull_request: + push: + paths: + - '.github/workflows/build-chart.yaml' + workflow_dispatch: + branches: + - main + +env: + TZ: Asia/Shanghai + REPO: "artifact.onwalk.net" + IMAGE: base/${{ github.repository }} + TAG: ${{ github.sha }} + DNS_AK: ${{ secrets.DNS_AK }} + DNS_SK: ${{ secrets.DNS_SK }} + PASSWORD: ${{ secrets.ADMIN_INIT_PASSWORD }} + DEBIAN_FRONTEND: noninteractive + HELM_EXPERIMENTAL_OCI: 1 + +jobs: + build-server-agent-chart: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Initialization environment + shell: bash + run: | + sudo apt update + sudo apt install git -y + sudo timedatectl set-timezone "$TZ" + sudo curl https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash + helm plugin install https://github.com/chartmuseum/helm-push.git + helm repo add sync https://charts.onwalk.net + helm repo add neo4j https://helm.neo4j.com/neo4j + helm repo add influxdata https://helm.influxdata.com + helm repo add bitnami https://charts.bitnami.com/bitnami + helm repo add fluent https://fluent.github.io/helm-charts + helm repo add grafana https://grafana.github.io/helm-charts + helm repo add deepflow https://deepflowio.github.io/deepflow + helm repo add kube-state-metrics https://kubernetes.github.io/kube-state-metrics + helm repo add prometheus-community https://prometheus-community.github.io/helm-charts + helm repo up + + - name: Sync UPstream Server charts + working-directory: charts/server + shell: bash + run: | + ls -l ; mkdir -pv charts/ && cd charts/ + rm -rvf neo4j ; helm fetch neo4j/neo4j --untar + rm -rvf grafana ; helm fetch grafana/grafana --untar + rm -rvf influxdb ; helm fetch influxdata/influxdb --untar + rm -rvf deepflow ; helm fetch deepflow/deepflow --version 6.2.6 --untar + rm -rvf prometheus ; helm fetch prometheus-community/prometheus --untar + rm -rvf alertmanager ; helm fetch prometheus-community/alertmanager --untar + ls -l && rm *.tgz -f + + - name: Build and Push Server chart + working-directory: charts/server + shell: bash + run: | + helm cm-push -u admin -p "${{ secrets.HELM_REPO_PASSWORD }}" --force ./ sync + ls -l + + - name: Sync UPstream Agent charts + working-directory: charts/agent + shell: bash + run: | + ls -l ; mkdir -pv charts/ && cd charts/ + rm -rvf promtail ; helm fetch grafana/promtail --untar + rm -rvf telegraf ; helm fetch influxdata/telegraf --untar + rm -rvf fluent-bit ; helm fetch fluent/fluent-bit --untar + rm -rvf grafana-agent-operator ; helm fetch grafana/grafana-agent-operator --untar + rm -rvf deepflow-agent ; helm fetch deepflow/deepflow-agent --version 6.2.6 --untar + rm -rvf prometheus-node-exporter ; helm fetch prometheus-community/prometheus-node-exporter --untar + rm -rvf kube-state-metrics ; helm fetch prometheus-community/kube-state-metrics --untar + rm -rvf prometheus ; helm fetch prometheus-community/prometheus --version=18.4.0 --untar + ls -l && rm *.tgz -f + + - name: Build and Push chart + working-directory: charts/agent + shell: bash + run: | + helm cm-push -u admin -p "${{ secrets.HELM_REPO_PASSWORD }}" --force ./ sync + ls -l + + - name: Merge Upstream Repo + shell: bash + run: | + git config user.name shenlan + git config user.email manbuzhe2009@qq.com + cd ${GITHUB_WORKSPACE}/ && rm *.tgz -f + rm -rvf ${GITHUB_WORKSPACE}/charts/server/*.tgz -f + rm -rvf ${GITHUB_WORKSPACE}/charts/agent/*.tgz -f + git add -A + git commit -a -m "Auto Merged" || echo true + git push + + build-app-chart: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + + - name: Initialization environment + shell: bash + run: | + sudo apt update + sudo apt install git -y + sudo curl https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash + helm plugin install https://github.com/chartmuseum/helm-push.git + + - name: Build and Push App chart + working-directory: charts/app + shell: bash + run: | + helm repo add sync https://charts.onwalk.net + helm repo up + helm cm-push -u admin -p "${{ secrets.HELM_REPO_PASSWORD }}" --force ./ sync + ls -l + sync-images: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Initialization environment + env: + PASSWORD: ${{ secrets.IAMGE_REPO_PASSWORD }} + shell: bash + run: | + sudo apt update + sudo apt install git -y + sudo timedatectl set-timezone "$TZ" + echo "$PASSWORD" | docker login --username=admin --password-stdin artifact.onwalk.net + + - name: Sync images + shell: bash + run: | + docker pull registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.7.0 + docker tag registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.7.0 artifact.onwalk.net/public/kube-state-metrics:v2.7.0 + docker push artifact.onwalk.net/public/kube-state-metrics:v2.7.0 + + docker pull ghcr.io/deepflowio/deepflow-ce/deepflow-agent:v6.2-8427@sha256:ffec192f8f249160fab600dab939ee150c067b4b1900378da247b748073b256e + docker tag ghcr.io/deepflowio/deepflow-ce/deepflow-agent:v6.2-8427@sha256:ffec192f8f249160fab600dab939ee150c067b4b1900378da247b748073b256e artifact.onwalk.net/public/deepflow-agent:v6.2 + docker push artifact.onwalk.net/public/deepflow-agent:v6.2 diff --git a/Solutions/Observability/.github/workflows/iac-pipeline-destroy.yml b/Solutions/Observability/.github/workflows/iac-pipeline-destroy.yml new file mode 100644 index 00000000..635330cc --- /dev/null +++ b/Solutions/Observability/.github/workflows/iac-pipeline-destroy.yml @@ -0,0 +1,199 @@ +name: Destroy Resources by IAC tools + +env: + STATE: "destroy" # 可以根据需要更改初始状态, 可选create，update, destroy + CLOUD: "gcp" # 选择云服务商, 可选: gcp, aws, ali, azure + +on: + pull_request: + push: + paths: + - '.github/workflows/iac-pipeline-destroy.yml' + workflow_dispatch: + branches: + - main + +jobs: + gcs: + runs-on: ubuntu-latest + needs: + - vhost + - network + - key_pair + - firewall + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Set up Google Cloud SDK + uses: 'google-github-actions/setup-gcloud@v1' + with: + version: '>= 363.0.0' + + - name: Delete Google Cloud Storage Bucket + run: | + gsutil -m rm -r gs://iac_gcp_terraform_state || true + gcloud storage buckets delete gs://iac_gcp_terraform_state --quiet || true + network: + runs-on: ubuntu-latest + needs: + - vhost + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Terraform Init And Apply + run: | + bash run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/network/ + vhost: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Fetch SSH Keys + run: echo "${{ secrets.SSH_PUBLIC_KEY }}" > ssh_keys.pub + working-directory: iac_modules/terraform/${{ env.CLOUD }}/vhost/ + + - name: Terraform Init And Apply + run: | + python3 scripts/init.py && bash scripts/run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/vhost/ + + key_pair: + runs-on: ubuntu-latest + needs: + - vhost + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Set up Google Cloud SDK + uses: 'google-github-actions/setup-gcloud@v1' + with: + version: '>= 363.0.0' + + - name: Check if SSH Metadata exists + id: check_ssh_metadata + run: bash scripts/check_ssh_metadata.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/key_pair/ + + - name: Fetch SSH Keys + if: steps.check_ssh_metadata.outputs.ssh_metadata_exists == 'false' + run: echo "${{ secrets.SSH_PUBLIC_KEY }}" > ssh_keys.pub + working-directory: iac_modules/terraform/${{ env.CLOUD }}/key_pair/ + + - name: Terraform Init And Apply + if: steps.check_ssh_metadata.outputs.ssh_metadata_exists == 'false' + run: | + python3 scripts/init.py && bash scripts/run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/key_pair/ + + firewall: + runs-on: ubuntu-latest + needs: + - vhost + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Terraform Init And Apply + run: | + python3 scripts/init.py && bash scripts/run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/firewall/ diff --git a/Solutions/Observability/.github/workflows/pipeline.yml b/Solutions/Observability/.github/workflows/pipeline.yml new file mode 100644 index 00000000..dbffda52 --- /dev/null +++ b/Solutions/Observability/.github/workflows/pipeline.yml @@ -0,0 +1,555 @@ +name: Create Resources by IAC tools + +env: + STATE: "create" # 可以根据需要更改初始状态, 可选create，update, destroy + CLOUD: "gcp" # 选择云服务商, 可选: gcp, aws, ali, azure + TZ: Asia/Shanghai + REPO: "artifact.onwalk.net" + IMAGE: base/${{ github.repository }} + TAG: ${{ github.sha }} + DNS_AK: ${{ secrets.DNS_AK }} + DNS_SK: ${{ secrets.DNS_SK }} + SSH_USER: ${{ secrets.HOST_USER }} + SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }} + +on: + pull_request: + push: + paths: + - '.github/workflows/pipeline.yml' + workflow_dispatch: + branches: + - main + +jobs: + gcs: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Set up Google Cloud SDK + uses: 'google-github-actions/setup-gcloud@v1' + with: + version: '>= 363.0.0' + + - name: Check if GCS bucket exists + id: check_bucket + run: | + BUCKET_NAME="iac_gcp_terraform_state" + gsutil ls -b gs://${BUCKET_NAME} || echo "::set-output name=bucket_exists::false" + + - name: Terraform Init And Apply + if: steps.check_bucket.outputs.bucket_exists == 'false' + run: | + bash run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/gcs/ + network: + runs-on: ubuntu-latest + needs: + - gcs + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Terraform Init And Apply + run: | + bash run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/network/ + vhost: + runs-on: ubuntu-latest + needs: + - gcs + - network + - key_pair + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Fetch SSH Keys + run: echo "${{ secrets.SSH_PUBLIC_KEY }}" > ssh_keys.pub + working-directory: iac_modules/terraform/${{ env.CLOUD }}/vhost/ + + - name: Terraform Init And Apply + run: | + python3 scripts/init.py && bash scripts/run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/vhost/ + + key_pair: + runs-on: ubuntu-latest + needs: + - gcs + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Set up Google Cloud SDK + uses: 'google-github-actions/setup-gcloud@v1' + with: + version: '>= 363.0.0' + + - name: Check if SSH Metadata exists + id: check_ssh_metadata + run: bash scripts/check_ssh_metadata.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/key_pair/ + + - name: Fetch SSH Keys + if: steps.check_ssh_metadata.outputs.ssh_metadata_exists == 'false' + run: echo "${{ secrets.SSH_PUBLIC_KEY }}" > ssh_keys.pub + working-directory: iac_modules/terraform/${{ env.CLOUD }}/key_pair/ + + - name: Terraform Init And Apply + if: steps.check_ssh_metadata.outputs.ssh_metadata_exists == 'false' + run: | + python3 scripts/init.py && bash scripts/run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/key_pair/ + + firewall: + runs-on: ubuntu-latest + needs: + - gcs + - network + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Terraform Init And Apply + run: | + python3 scripts/init.py && bash scripts/run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/firewall/ + + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Initialization environment + shell: bash + run: | + sudo apt update + sudo apt install git -y + sudo timedatectl set-timezone "$TZ" + sudo curl https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash + helm plugin install https://github.com/chartmuseum/helm-push.git + helm repo add neo4j https://helm.neo4j.com/neo4j + helm repo add bitnami https://charts.bitnami.com/bitnami + helm repo add fluent https://fluent.github.io/helm-charts + helm repo add grafana https://grafana.github.io/helm-charts + helm repo add deepflow https://deepflowio.github.io/deepflow + helm repo add kube-state-metrics https://kubernetes.github.io/kube-state-metrics + helm repo add prometheus-community https://prometheus-community.github.io/helm-charts + + - name: Sync UPstream Server charts + working-directory: charts/server + shell: bash + run: | + ls -l ; mkdir -pv charts/ && cd charts/ + rm -rvf neo4j ; helm fetch neo4j/neo4j --untar + rm -rvf grafana ; helm fetch grafana/grafana --untar + rm -rvf deepflow ; helm fetch deepflow/deepflow --version 6.2.6 --untar + rm -rvf prometheus ; helm fetch prometheus-community/prometheus --untar + rm -rvf alertmanager ; helm fetch prometheus-community/alertmanager --untar + ls -l && rm *.tgz -f + + - name: Build and Push Server chart + working-directory: charts/server + shell: bash + run: | + helm repo add sync https://charts.onwalk.net + helm repo up + helm cm-push -u admin -p "${{ secrets.HELM_REPO_PASSWORD }}" --force ./ sync + ls -l + + - name: Sync UPstream Agent charts + working-directory: charts/agent + shell: bash + run: | + ls -l ; mkdir -pv charts/ && cd charts/ + rm -rvf promtail ; helm fetch grafana/promtail --untar + rm -rvf fluent-bit ; helm fetch fluent/fluent-bit --untar + rm -rvf deepflow-agent ; helm fetch deepflow/deepflow-agent --version 6.2.6 --untar + rm -rvf grafana-agent-operator ; helm fetch grafana/grafana-agent-operator --untar + rm -rvf kube-state-metrics ; helm fetch prometheus-community/kube-state-metrics --untar + rm -rvf prometheus ; helm fetch prometheus-community/prometheus --version=18.4.0 --untar + ls -l && rm *.tgz -f + + - name: Build and Push chart + working-directory: charts/agent + shell: bash + run: | + helm repo add sync https://charts.onwalk.net + helm repo up + helm cm-push -u admin -p "${{ secrets.HELM_REPO_PASSWORD }}" --force ./ sync + ls -l + + - name: Merge Upstream Repo + shell: bash + run: | + git config user.name shenlan + git config user.email manbuzhe2009@qq.com + cd ${GITHUB_WORKSPACE}/ && rm *.tgz -f + rm -rvf ${GITHUB_WORKSPACE}/charts/server/*.tgz -f + rm -rvf ${GITHUB_WORKSPACE}/charts/agent/*.tgz -f + git add -A + git commit -a -m "Auto Merged" || echo true + git push + + sync-images: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Initialization environment + env: + PASSWORD: ${{ secrets.IAMGE_REPO_PASSWORD }} + shell: bash + run: | + sudo apt update + sudo apt install git -y + sudo timedatectl set-timezone "$TZ" + echo "$PASSWORD" | docker login --username=admin --password-stdin artifact.onwalk.net + + - name: Sync images + shell: bash + run: | + docker pull registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.7.0 + docker tag registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.7.0 artifact.onwalk.net/public/kube-state-metrics:v2.7.0 + docker push artifact.onwalk.net/public/kube-state-metrics:v2.7.0 + + docker pull ghcr.io/deepflowio/deepflow-ce/deepflow-agent:v6.2-8427@sha256:ffec192f8f249160fab600dab939ee150c067b4b1900378da247b748073b256e + docker tag ghcr.io/deepflowio/deepflow-ce/deepflow-agent:v6.2-8427@sha256:ffec192f8f249160fab600dab939ee150c067b4b1900378da247b748073b256e artifact.onwalk.net/public/deepflow-agent:v6.2 + docker push artifact.onwalk.net/public/deepflow-agent:v6.2 + + test: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Test aritfacts + run: echo "to do" + + setup-server-cluster: + runs-on: ubuntu-latest + needs: + - build + - test + - vhost + env: + SSH_HOST_DOMAIN: ${{ secrets.SERVER_HOST_DOMAIN }} + + steps: + - name: Checkout code + uses: actions/checkout@v3 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Set GitHub Actions output variables + id: terraform-output + run: | + python3 scripts/init.py && terraform init + terraform output | while read -r line; do + if [ -z "$line" ]; then + break + else + k_v=$(echo "$line" | tr -d ' ' | awk -F= '{print $1"="$2}') + echo "$k_v" >> $GITHUB_OUTPUT + fi + done + working-directory: iac_modules/terraform/${{ env.CLOUD }}/vhost/ + + - name: Update playbook hosts + run: | + bash observability-platform-pre_setup.sh + env: + SSH_HOST_IP: ${{ steps.terraform-output.outputs.server }} + working-directory: playbook/ + + - name: Setup K3S Cluster + shell: bash + run: | + export ANSIBLE_HOST_KEY_CHECKING=False + ansible-playbook -i hosts/inventory init_k3s_cluster_std -e "cluster_name=monitor" -D + working-directory: playbook/ + + setup-app-cluster: + runs-on: ubuntu-latest + needs: + - build + - test + - vhost + env: + SSH_HOST_DOMAIN: ${{ secrets.APP_HOST_DOMAIN }} + + steps: + - name: Checkout code + uses: actions/checkout@v3 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Set GitHub Actions output variables + id: terraform-output + run: | + python3 scripts/init.py && terraform init + terraform output | while read -r line; do + if [ -z "$line" ]; then + break + else + k_v=$(echo "$line" | tr -d ' ' | awk -F= '{print $1"="$2}') + echo "$k_v" >> $GITHUB_OUTPUT + fi + done + working-directory: iac_modules/terraform/${{ env.CLOUD }}/vhost/ + + - name: Update playbook hosts + run: | + bash observability-platform-pre_setup.sh + env: + SSH_HOST_IP: ${{ steps.terraform-output.outputs.app }} + working-directory: playbook/ + + - name: Setup K3S Cluster + shell: bash + run: | + export ANSIBLE_HOST_KEY_CHECKING=False + ansible-playbook -i hosts/inventory init_k3s_cluster_std -e "cluster_name=app" -D + working-directory: playbook/ + + deploy-server: + runs-on: ubuntu-latest + needs: + - setup-server-cluster + env: + SSH_HOST_DOMAIN: ${{ secrets.SERVER_HOST_DOMAIN }} + + steps: + - name: Checkout code + uses: actions/checkout@v3 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Set GitHub Actions output variables + id: terraform-output + run: | + python3 scripts/init.py && terraform init + terraform output | while read -r line; do + if [ -z "$line" ]; then + break + else + k_v=$(echo "$line" | tr -d ' ' | awk -F= '{print $1"="$2}') + echo "$k_v" >> $GITHUB_OUTPUT + fi + done + working-directory: iac_modules/terraform/${{ env.CLOUD }}/vhost/ + + - name: Update playbook hosts + run: bash observability-platform-pre_setup.sh + env: + SSH_HOST_IP: ${{ steps.terraform-output.outputs.server }} + working-directory: playbook/ + + - name: Deploy ansible-playbook Observability Server + run: | + export ANSIBLE_HOST_KEY_CHECKING=False + ansible-playbook -i hosts/inventory init_observability-server -D + working-directory: playbook/ + + deploy-agent: + runs-on: ubuntu-latest + needs: + - setup-app-cluster + env: + SSH_HOST_DOMAIN: ${{ secrets.APP_HOST_DOMAIN }} + + steps: + - name: Checkout code + uses: actions/checkout@v3 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Set GitHub Actions output variables + id: terraform-output + run: | + python3 scripts/init.py && terraform init + terraform output | while read -r line; do + if [ -z "$line" ]; then + break + else + k_v=$(echo "$line" | tr -d ' ' | awk -F= '{print $1"="$2}') + echo "$k_v" >> $GITHUB_OUTPUT + fi + done + working-directory: iac_modules/terraform/${{ env.CLOUD }}/vhost/ + + - name: Update playbook hosts + run: bash observability-platform-pre_setup.sh + env: + SSH_HOST_IP: ${{ steps.terraform-output.outputs.app }} + working-directory: playbook/ + + - name: Deploy ansible-playbook Observability Agent + run: | + export ANSIBLE_HOST_KEY_CHECKING=False + ansible-playbook -i hosts/inventory init_observability-agent -D + working-directory: playbook/ diff --git a/Solutions/Observability/.github/workflows/setup-agent.yaml b/Solutions/Observability/.github/workflows/setup-agent.yaml new file mode 100644 index 00000000..ba4b1799 --- /dev/null +++ b/Solutions/Observability/.github/workflows/setup-agent.yaml @@ -0,0 +1,112 @@ +name: Only Setup Agent + +on: + pull_request: + push: + paths: + - '.github/workflows/setup-agent.yaml' + workflow_dispatch: + branches: + - main + +defaults: + run: + working-directory: ./playbook + +env: + TZ: Asia/Shanghai + REPO: "artifact.onwalk.net" + IMAGE: base/${{ github.repository }} + TAG: ${{ github.sha }} + DNS_AK: ${{ secrets.DNS_AK }} + DNS_SK: ${{ secrets.DNS_SK }} + PASSWORD: ${{ secrets.ADMIN_INIT_PASSWORD }} + DEBIAN_FRONTEND: noninteractive + HELM_EXPERIMENTAL_OCI: 1 + +jobs: + setup-k3s: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + + - name: update submodule + run: | + sudo apt-get update && sudo apt-get install -y git && git submodule update --init --recursive + + - name: Setup K3S Cluster + shell: bash + run: | + export ANSIBLE_HOST_KEY_CHECKING=False + sudo apt install jq ansible -y + + mkdir -pv ~/.ssh/ + cat > ~/.ssh/id_rsa << EOF + ${{ secrets.SSH_PRIVATE_KEY }} + EOF + sudo chmod 0400 ~/.ssh/id_rsa + md5sum ~/.ssh/id_rsa + + mkdir -pv hosts/ + + cat > hosts/inventory << EOF + [master] + ${{ secrets.APP_HOST_DOMAIN }} ansible_host=${{ secrets.APP_HOST_IP }} + + [all:vars] + ansible_port=22 + ansible_ssh_user=${{ secrets.APP_HOST_USER }} + ansible_ssh_private_key_file=~/.ssh/id_rsa + ansible_host_key_checking=False + ingress_ip=${{ secrets.APP_HOST_IP }} + dns_ak=$DNS_AK + dns_sk=$DNS_SK + EOF + cat hosts/inventory + ansible-playbook -i hosts/inventory init_k3s_cluster_std -D + setup-agent: + runs-on: ubuntu-latest + needs: + - setup-k3s + + steps: + - uses: actions/checkout@v3 + + - name: update submodule + run: | + sudo apt-get update && sudo apt-get install -y git && git submodule update --init --recursive + + - name: Pre setup for Ansible playbook + run: | + sudo apt install jq ansible -y + + mkdir -pv ~/.ssh/ + cat > ~/.ssh/id_rsa << EOF + ${{ secrets.SSH_PRIVATE_KEY }} + EOF + sudo chmod 0400 ~/.ssh/id_rsa + md5sum ~/.ssh/id_rsa + + + - name: Setup Observability Agent + shell: bash + run: | + export ANSIBLE_HOST_KEY_CHECKING=False + + mkdir -pv hosts/ + cat > hosts/inventory << EOF + [master] + ${{ secrets.APP_HOST_DOMAIN }} ansible_host=${{ secrets.APP_HOST_IP }} + + [all:vars] + ansible_port=22 + ansible_ssh_user=${{ secrets.APP_HOST_USER }} + ansible_ssh_private_key_file=~/.ssh/id_rsa + ansible_host_key_checking=False + admin_password=$PASSWORD + dns_ak=$DNS_AK + dns_sk=$DNS_SK + EOF + + ansible-playbook -i hosts/inventory init_observability-agent -D diff --git a/Solutions/Observability/.github/workflows/setup-server.yaml b/Solutions/Observability/.github/workflows/setup-server.yaml new file mode 100644 index 00000000..6f02138b --- /dev/null +++ b/Solutions/Observability/.github/workflows/setup-server.yaml @@ -0,0 +1,70 @@ +name: Only Setup Server + +on: + pull_request: + push: + paths: + - '.github/workflows/setup-server.yaml' + workflow_dispatch: + branches: + - main + +defaults: + run: + working-directory: ./playbook + +env: + TZ: Asia/Shanghai + REPO: "artifact.onwalk.net" + IMAGE: base/${{ github.repository }} + TAG: ${{ github.sha }} + DNS_AK: ${{ secrets.DNS_AK }} + DNS_SK: ${{ secrets.DNS_SK }} + PASSWORD: ${{ secrets.ADMIN_INIT_PASSWORD }} + DEBIAN_FRONTEND: noninteractive + HELM_EXPERIMENTAL_OCI: 1 + +jobs: + setup-server: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + + - name: update submodule + run: | + sudo apt-get update && sudo apt-get install -y git && git submodule update --init --recursive + + - name: Pre setup for Ansible playbook + run: | + sudo apt install jq ansible -y + + mkdir -pv ~/.ssh/ + cat > ~/.ssh/id_rsa << EOF + ${{ secrets.SSH_PRIVATE_KEY }} + EOF + sudo chmod 0400 ~/.ssh/id_rsa + md5sum ~/.ssh/id_rsa + + + - name: Deploy Observability Server + shell: bash + run: | + export ANSIBLE_HOST_KEY_CHECKING=False + + mkdir -pv hosts/ + cat > hosts/server << EOF + [master] + ${{ secrets.HOST_DOMAIN }} ansible_host=${{ secrets.HOST_IP }} + + [all:vars] + ansible_port=22 + ansible_ssh_user=${{ secrets.HOST_USER }} + ansible_ssh_private_key_file=~/.ssh/id_rsa + ansible_host_key_checking=False + admin_password=$PASSWORD + dns_ak=$DNS_AK + dns_sk=$DNS_SK + EOF + + ansible-playbook -i hosts/server init_observability-server -D diff --git a/Solutions/Observability/.gitmodules b/Solutions/Observability/.gitmodules new file mode 100644 index 00000000..a4ef0241 --- /dev/null +++ b/Solutions/Observability/.gitmodules @@ -0,0 +1,6 @@ +[submodule "iac_modules"] + path = iac_modules + url = https://github.com/svc-design/iac_modules.git +[submodule "playbook"] + path = playbook + url = https://github.com/svc-design/playbook.git diff --git a/Solutions/Observability/LICENSE b/Solutions/Observability/LICENSE new file mode 100644 index 00000000..f288702d --- /dev/null +++ b/Solutions/Observability/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Solutions/Observability/README.md b/Solutions/Observability/README.md new file mode 100644 index 00000000..93cd3cc2 --- /dev/null +++ b/Solutions/Observability/README.md @@ -0,0 +1,117 @@ +# ObservabilityPlatform + +该解决方案使用 ClickHouse、Neo4j、VectorDB、PromQL、LogQL、OpenTracing、Prometheus、Grafana、AlertManager 和 DeepFlow 等开源工具。开源的可观察性平台解决方案通过 GitHub Actions 自动交付创建服务。 + +# 架构图 + +![请在此添加图片描述](https://developer.qcloudimg.com/http-save/yehe-2810186/a4bab250e17d279a9a09c794249a09d6.png?qc_blockWidth=620&qc_blockHeight=435) + +该解决方案使用以下开源软件： + +- 数据收集：使用 Prometheus、OpenTelemetry，Deepflow-agent，Promtail，cloudquery 等工具从系统组件、应用程序和云账户数据同步 +- 数据存储：使用 ClickHouse、Neo4j、VectorDB 等工具存储观测数据。 +- 数据分析：使用 Prometheus、Grafana 等工具分析观测数据。 +- 数据可视化：使用 Grafana 等工具以可视化的方式呈现观测数据。 + + +# CICD +流水线配置文件 +配置文件位于 .github/workflows/pipeline.yaml 由四个阶段组成： + +- 构建测试：此阶段从源代码构建 APP, 并运行测试套件，以确保APP 正常工作。 +- Docker 镜像：此阶段构建一个包含 APP 的 Docker 镜像。 +- 设置 K3s：此阶段在远程服务器上设置 K3s 集群。 +- 部署应用：此阶段将 APP 部署到 K3s 集群。 + +# Playook 角色说明 + +可观察性平台配置库由以下角色组成： + +node-exporter: 部署 node_exporter 来收集系统指标。 +prometheus-transfer: 转发 Prometheus 将指标传输到远程存储。 +promtail-agent: 部署 Promtail 从节点收集日志。 +k3s: 提供管理 k3s 集群的任务。 +k3s-addon: 部署 k3s 附加组件。 +k3s-reset: 将 k3s 集群重置为初始状态。 +secret-manger: 部署 secret-manager 来管理敏感数据。 +cert-manager: 部署 cert-manager 以颁发 TLS 证书。 +clickhouse: 部署 Clickhouse 以存储和分析时序数据。 +observability-agent: 在 k3s 节点上部署可观察性代理。 +observability-server: 部署可观察性服务器组件。 +mysql: 部署 MySQL 以存储 Deepflow数据以及Grafana配置信息。 +alerting: 存储 Prometheus Alertmanager Rules 。 + +容器集群相关相关的 Ansible playbook roles + +非容器集群相关的 Ansible playbook roles + +## 触发器 +管道由以下事件触发： + +- 当打开或更新拉取请求时。 +- 当代码推送到主分支时。 +- 当工作流程手动调度时。 + +## 环境变量 + +在YAML文件或CI/CD流水线配置中定义的ENV变量： + +- TZ: Asia/Shanghai：设置时区为Asia/Shanghai。 +- REPO: "artifact.onwalk.net"：指定一个存储库的URL或标识符。 +- IMAGE: base/${{ github.repository }}：基于GitHub存储库构建一个容器镜像名称。 +- TAG: ${{ github.sha }}：将镜像标签设置为GitHub存储库的提交SHA。 +- DNS_AK: ${{ secrets.DNS_AK }}：使用GitHub的密钥设置阿里云DNS访问密钥。 +- DNS_SK: ${{ secrets.DNS_SK }}：使用GitHub的密钥设置阿里云DNS密钥。 +- DEBIAN_FRONTEND: noninteractive：将Debian前端设置为非交互模式，这在自动化脚本中很有用，可防止交互提示。 +- HELM_EXPERIMENTAL_OCI: 1：启用Helm中的实验性OCI（Open Container Initiative）支持，允许Helm与OCI镜像一起使用。 + +如需在自己的账号运行这个Demo，只需要将 https://github.com/open-source-solution-design/ObservabilityPlatform.git 这个仓库Fork 到你自己的Github账号下，同时在 + +Settings -> Actions secrets and variables: 添加流水线需要定义的 secrets 变量 + +Server 相关 secrets 变量 + +- HELM_REPO_USER Artifact 仓库认证用户名 +- HELM_REPO_REGISTRY Artifact 仓库认证地址 +- HELM_REPO_PASSWORD Artifact 仓库认证密码 +- HOST_USER 部署K3S的主机OS登陆用户名 +- HOST_IP 部署K3S的主机IP地址 +- HOST_DOMAIN 部署K3S的主机域名 +- SSH_PRIVATE_KEY 访问K3S的主机的SSH 私钥 +- DNS_AK 阿里云DNS 服务 AK (用于自动签发SSL证书和更新解析记录，发布ingress ) +- DNS_SK 阿里云DNS 服务 SK (用于自动签发SSL证书和更新解析记录，发布ingress ) + +客户端相关 secrets 变量 + +- APP_HOST_USER 部署APP集群的master 主机OS登陆用户名 +- APP_HOST_IP 部署APP集群的master 主机IP地址 +- APP_HOST_DOMAIN 部署APP集群的master 主机IP域名 + +# API Endpoint + +| name | URI | +| --- | --- | +| querying(promql, logql, tempo) | http://data-gateway. | +| metrics_query | https://prometheus./api/v1/query | +| metrics_remote_write | https://prometheus./api/v1/remote/write | +| logql_remote_query | https://data-gateway./loki/api/v1/query | +| logql_remote_write | https://data-gateway./loki/api/v1/push | +| traces_tempo_push | https://data-gateway./tempo/api/push | +| traces_zipkin_push | https://data-gateway./api/v2/spans | +| traces_oltp_push | https://data-gateway./v1/traces | +| Query Traces | https://data-gateway./api/traces/{traceId} | +| Query Traces (JSON) | https://data-gateway./api/traces/{traceId}/json | + + +# Reference + +1. 可观测平台-2: 开源解决方案 + https://cloud.tencent.com/developer/article/2363793 +3. 可观测平台-3: 应用系统告警项 +https://cloud.tencent.com/developer/article/2370478 +可观测平台-3.1: Web前端/后端/网关 监控项: +https://cloud.tencent.com/developer/article/2370608 +可观测平台-3.2: Cache/MQ/TQ 中间件监控项原创: +https://cloud.tencent.com/developer/article/2370613 +可观测平台-3.3: 数据库监控项： +https://cloud.tencent.com/developer/article/2370615 diff --git a/Solutions/Observability/docs/class-statu.uml b/Solutions/Observability/docs/class-statu.uml new file mode 100644 index 00000000..eb08bd3e --- /dev/null +++ b/Solutions/Observability/docs/class-statu.uml @@ -0,0 +1,39 @@ + +@startuml +package "Observability platform" { + class ClickHouse + class Neo4j + class VectorDB + class Prometheus + class Grafana + class AlertManager + class DeepFlow + class CloudQuery + class LangChain +} + +ClickHouse "1" -- "1" DeepFlow : 流式数据处理 +ClickHouse "1" -- "1" Prometheus : 流式数据处理 + +Prometheus "1" -- "1" AlertManager : 告警 + +Grafana "1" -- "1" ClickHouse : 数据可视化 +Grafana "1" -- "1" Neo4j : 数据可视化 +Grafana "1" -- "1" DeepFlow : 数据可视化 + +Collector "1" -- "1" ClickHouse : 数据可视化 + +LogQL "1" -- "1" Collector : 数据可视化 +PromQL "1" -- "1" Collector : 数据可视化 +OpenTracing "1" -- "1" Collector : 数据可视化 + + +CloudQuery "1" -- "1" Neo4j : 数据同步 +ClickHouse -- "1" VectorDB : 数据同步 +Neo4j -- "1" VectorDB : 数据同步 +VectorDB "1" -- "1" LangChain : 数据处理 + +LangChain "1" -- "1" GitOPS : 数据处理 + +DeepFlow "1" -- "1" Prometheus : 推送状态 +@enduml diff --git a/Solutions/Observability/docs/monitor-system-State-Diagram.uml b/Solutions/Observability/docs/monitor-system-State-Diagram.uml new file mode 100644 index 00000000..08d7edba --- /dev/null +++ b/Solutions/Observability/docs/monitor-system-State-Diagram.uml @@ -0,0 +1,65 @@ +@startuml +title System State Diagram + +state Resource { + IaaS --> PrometheusAgent: push + PaaS --> PrometheusAgent: pull + PaaS --> PrometheusAgent: pull + + IaaS --> LogAgent: push + PaaS --> LogAgent: pull + SaaS --> LogAgent: pull + + App --> LogAgent: pull + App --> TraceAgent: SDK + App --> PrometheusAgent: pull + + MultiCloudResource --> ResourceCollector: sync + k8sClusterResource --> ResourceCollector: sync + IacState --> ResourceCollector: sync +} + +state PrometheusAgent { + MetricWrite --> MetricServer: Metric Sent +} + +state LogAgent { + LogWrite --> DataServer: Metric Sent +} + +state "OpenTelemetry" as TraceAgent { + TraceLogWrite --> DataServer: Trace Sent +} + +state "cloudquery" as ResourceCollector { + ResourceCollector --> GraphDBServer: Resource List Sent +} + +state "Prometheus" as MetricServer { +} + +state "ClickHouse" as DataServer { +} + +state "Neo4j" as GraphDBServer { +} + +state "AlertManager" as AlertServer { +} + +state "SNS" as Alert { +} + +state "Grafana" as Dashboard { +} + +LogAgent --> DataServer : Log Sent +PrometheusAgent --> MetricServer : Metric Sent +MetricServer --> AlertServer : Alert Sent +AlertServer --> Alert + +MetricServer --> Dashboard : Metric Dashboard Displayed +DataServer --> Dashboard : Trace/Log Dashboard Displayed +AlertServer --> Dashboard : Alert Dashboard Displayed +GraphDBServer --> Dashboard : Resource Dashboard Displayed +@enduml diff --git a/Solutions/Observability/example/deploy/alpine-tools.yaml b/Solutions/Observability/example/deploy/alpine-tools.yaml new file mode 100644 index 00000000..b031ab59 --- /dev/null +++ b/Solutions/Observability/example/deploy/alpine-tools.yaml @@ -0,0 +1,24 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: alpine-tools-deployment +spec: + replicas: 1 + selector: + matchLabels: + app: alpine-tools + template: + metadata: + labels: + app: alpine-tools + spec: + containers: + - name: alpine + image: alpine:latest + command: ["/bin/sh", "-c", "apk update && apk add --no-cache bash curl iputils && sleep infinity"] + resources: {} + tolerations: + - key: "key1" + operator: "Equal" + value: "ingress" + effect: "NoExecute" diff --git a/Solutions/Observability/example/deploy/deployment.yaml b/Solutions/Observability/example/deploy/deployment.yaml new file mode 100644 index 00000000..d019686c --- /dev/null +++ b/Solutions/Observability/example/deploy/deployment.yaml @@ -0,0 +1,62 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: ticketing + labels: + app.kubernetes.io/instance: ticketing + app.kubernetes.io/managed-by: Helm + app.kubernetes.io/name: itsm +spec: + progressDeadlineSeconds: 600 + replicas: 1 + revisionHistoryLimit: 10 + selector: + matchLabels: + app.kubernetes.io/instance: ticketing + app.kubernetes.io/name: itsm + strategy: + rollingUpdate: + maxSurge: 25% + maxUnavailable: 25% + type: RollingUpdate + template: + metadata: + labels: + app.kubernetes.io/instance: ticketing + app.kubernetes.io/name: itsm + spec: + containers: + - image: "{{ .Values.images.tags.ticketing }}" + imagePullPolicy: IfNotPresent + name: ticketing + ports: + - containerPort: 8000 + name: http + protocol: TCP + - containerPort: 9000 + name: grpc + protocol: TCP + resources: + limits: + cpu: "2" + memory: 1280Mi + requests: + cpu: 20m + memory: 128Mi + securityContext: { } + volumeMounts: + - mountPath: /ticketing/conf + name: ticketing-config + dnsPolicy: ClusterFirst + restartPolicy: Always + schedulerName: default-scheduler + securityContext: { } + terminationGracePeriodSeconds: 30 + volumes: + - name: ticketing-config + secret: + defaultMode: 420 + items: + - key: ticketing.yaml + path: config.yaml + secretName: itsm diff --git a/Solutions/Observability/example/deploy/ingress.yaml b/Solutions/Observability/example/deploy/ingress.yaml new file mode 100644 index 00000000..4f470cd8 --- /dev/null +++ b/Solutions/Observability/example/deploy/ingress.yaml @@ -0,0 +1,85 @@ +apiVersion: networking.k8s.io/v1 +kind: Ingress +metadata: + name: itsm +spec: + rules: + - host: ldap-directory.example.com + http: + paths: + - backend: + service: + name: ldap-directory + port: + number: 8000 + path: /swagger + pathType: ImplementationSpecific + - backend: + service: + name: ldap-directory + port: + number: 8000 + path: /metrics + pathType: ImplementationSpecific + - backend: + service: + name: ldap-directory + port: + number: 8000 + path: /api/v1/users + pathType: ImplementationSpecific + - backend: + service: + name: ldap-directory + port: + number: 8000 + path: /api/v1/groups + pathType: ImplementationSpecific + - host: platform.example.com + http: + paths: + - backend: + service: + name: platform + port: + number: 8000 + path: /swagger + pathType: ImplementationSpecific + - backend: + service: + name: ldap-directory + port: + number: 8000 + path: /metrics + pathType: ImplementationSpecific + - backend: + service: + name: platform + port: + number: 8000 + path: /api/v1 + pathType: ImplementationSpecific + - host: ticketing.example.com + http: + paths: + - backend: + service: + name: ticketing + port: + number: 8000 + path: /swagger + pathType: ImplementationSpecific + - backend: + service: + name: ldap-directory + port: + number: 8000 + path: /metrics + pathType: ImplementationSpecific + - backend: + service: + name: ticketing + port: + number: 8000 + path: /api/v1 + pathType: ImplementationSpecific diff --git a/Solutions/Observability/example/deploy/service.yaml b/Solutions/Observability/example/deploy/service.yaml new file mode 100644 index 00000000..c76b710d --- /dev/null +++ b/Solutions/Observability/example/deploy/service.yaml @@ -0,0 +1,22 @@ +apiVersion: v1 +kind: Service +metadata: + labels: + app.kubernetes.io/instance: ticketing + app.kubernetes.io/name: itsm + name: ticketing +spec: + ports: + - name: http + port: 8000 + protocol: TCP + targetPort: http + - name: grpc + port: 9000 + protocol: TCP + targetPort: grpc + selector: + app.kubernetes.io/instance: ticketing + app.kubernetes.io/name: itsm + sessionAffinity: None + type: ClusterIP diff --git a/Solutions/Observability/example/deploy/setup-ClickHouse.sh b/Solutions/Observability/example/deploy/setup-ClickHouse.sh new file mode 100644 index 00000000..f8f2be0b --- /dev/null +++ b/Solutions/Observability/example/deploy/setup-ClickHouse.sh @@ -0,0 +1,20 @@ +# 添加 ClickHouse Helm 仓库 +helm repo add clickhouse https://helm-clickhouse-test-repo.storage.googleapis.com/ + +# 更新 Helm 仓库 +helm repo update + +# 创建 ClickHouse 的 values.yaml +cat > clickhouse-values.yaml << EOF +replicas: 1 +resources: + requests: + cpu: "500m" + memory: "512Mi" + limits: + cpu: "1000m" + memory: "1Gi" +EOF + +# 部署 ClickHouse +helm upgrade --install clickhouse clickhouse/clickhouse -f clickhouse-values.yaml diff --git a/Solutions/Observability/example/deploy/setup-NebulaGraph.sh b/Solutions/Observability/example/deploy/setup-NebulaGraph.sh new file mode 100644 index 00000000..8de24a1c --- /dev/null +++ b/Solutions/Observability/example/deploy/setup-NebulaGraph.sh @@ -0,0 +1,41 @@ + +# 添加 NebulaGraph Helm 仓库 +helm repo add nebula-graph https://vesoft-inc.github.io/nebula-helm/ + +# 更新 Helm 仓库 +helm repo update + +# 创建 NebulaGraph 的 values.yaml +cat > nebulagraph-values.yaml << EOF +metad: + replicas: 1 + resources: + requests: + cpu: "500m" + memory: "512Mi" + limits: + cpu: "1000m" + memory: "1Gi" +storaged: + replicas: 1 + resources: + requests: + cpu: "500m" + memory: "512Mi" + limits: + cpu: "1000m" + memory: "1Gi" +graphd: + replicas: 1 + resources: + requests: + cpu: "500m" + memory: "512Mi" + limits: + cpu: "1000m" + memory: "1Gi" +EOF + +# 部署 NebulaGraph +helm upgrade --install my-nebulagraph nebula-graph/nebula-graph -f nebulagraph-values.yaml + diff --git a/Solutions/Observability/example/deploy/setup-Neo4j.sh b/Solutions/Observability/example/deploy/setup-Neo4j.sh new file mode 100644 index 00000000..e3f8493c --- /dev/null +++ b/Solutions/Observability/example/deploy/setup-Neo4j.sh @@ -0,0 +1,28 @@ +# 添加 Neo4j Helm 仓库 +helm repo add neo4j https://helm.neo4j.com/neo4j + +# 更新 Helm 仓库 +helm repo update + +# 创建 Neo4j 的 values.yaml +cat > neo4j-values.yaml << EOF +auth: + enabled: true + neo4j: + username: neo4j + password: myneo4jpassword +neo4j: + edition: community +core: + numberOfServers: 1 + resources: + requests: + cpu: "500m" + memory: "512Mi" + limits: + cpu: "1000m" + memory: "1Gi" +EOF + +# 部署 Neo4j +helm upgrade --install my-neo4j neo4j/neo4j -f neo4j-values.yaml diff --git a/Solutions/Observability/example/deploy/setup-ingress.sh b/Solutions/Observability/example/deploy/setup-ingress.sh new file mode 100644 index 00000000..d5b2b8d5 --- /dev/null +++ b/Solutions/Observability/example/deploy/setup-ingress.sh @@ -0,0 +1,55 @@ +cat > value.yaml < nginx-cm.yaml < nginx-svc-patch.yaml < ${domain}.pem +cat ~/.acme.sh/${domain}_ecc/ca.cer >> ${domain}.pem +cat ~/.acme.sh/${domain}_ecc/${domain}.key > ${domain}.key +sudo cp ${domain}.pem /etc/ssl/ -f && sudo cp ${domain}.key /etc/ssl/ -f diff --git a/Solutions/Observability/example/yaml/rennew-svc-plus.sh b/Solutions/Observability/example/yaml/rennew-svc-plus.sh new file mode 100644 index 00000000..2b3deef8 --- /dev/null +++ b/Solutions/Observability/example/yaml/rennew-svc-plus.sh @@ -0,0 +1,29 @@ +#!/bin/bash +set -x +export domain=svc.plus +export Ali_Key= +export Ali_Secret= + +rm -fv ${domain}.key ${domain}.pem -f +rm -fv /etc/ssl/${domain}.* -f + +# Try to issue a certificate from ZeroSSL. If it fails, try Let's Encrypt. + +curl https://get.acme.sh | sh -s email=156405189@qq.com +sh ~/.acme.sh/acme.sh --set-default-ca --server zerossl --issue --force --dns dns_ali -d ${domain} -d "*.${domain}" +if [ $? -eq 0 ]; then + echo "Certificate from letsencrypt successfully issued" +else + sh ~/.acme.sh/acme.sh --set-default-ca --server letsencrypt --issue --force --dns dns_ali -d ${domain} -d "*.${domain}" + if [ $? -eq 0 ]; then + echo "Certificate from zerossl successfully issued" + else + echo "Command failed" + exit 1 + fi +fi + +cat ~/.acme.sh/${domain}_ecc/${domain}.cer > ${domain}.pem +cat ~/.acme.sh/${domain}_ecc/ca.cer >> ${domain}.pem +cat ~/.acme.sh/${domain}_ecc/${domain}.key > ${domain}.key +sudo cp ${domain}.pem /etc/ssl/ -f && sudo cp ${domain}.key /etc/ssl/ -f diff --git a/Solutions/Observability/example/yaml/rennew.sh b/Solutions/Observability/example/yaml/rennew.sh new file mode 100644 index 00000000..d71bab37 --- /dev/null +++ b/Solutions/Observability/example/yaml/rennew.sh @@ -0,0 +1,29 @@ +#!/bin/bash +set -x +export domain=onwalk.net +export Ali_Key= +export Ali_Secret= + +rm -fv ${domain}.key ${domain}.pem -f +rm -fv /etc/ssl/${domain}.* -f + +# Try to issue a certificate from ZeroSSL. If it fails, try Let's Encrypt. + +curl https://get.acme.sh | sh -s email=156405189@qq.com +sh ~/.acme.sh/acme.sh --set-default-ca --server zerossl --issue --force --dns dns_ali -d ${domain} -d "*.${domain}" +if [ $? -eq 0 ]; then + echo "Certificate from letsencrypt successfully issued" +else + sh ~/.acme.sh/acme.sh --set-default-ca --server letsencrypt --issue --force --dns dns_ali -d ${domain} -d "*.${domain}" + if [ $? -eq 0 ]; then + echo "Certificate from zerossl successfully issued" + else + echo "Command failed" + exit 1 + fi +fi + +cat ~/.acme.sh/${domain}_ecc/${domain}.cer > ${domain}.pem +cat ~/.acme.sh/${domain}_ecc/ca.cer >> ${domain}.pem +cat ~/.acme.sh/${domain}_ecc/${domain}.key > ${domain}.key +sudo cp ${domain}.pem /etc/ssl/ -f && sudo cp ${domain}.key /etc/ssl/ -f diff --git a/Solutions/Observability/example/yaml/setup.sh b/Solutions/Observability/example/yaml/setup.sh new file mode 100644 index 00000000..5835e585 --- /dev/null +++ b/Solutions/Observability/example/yaml/setup.sh @@ -0,0 +1,20 @@ +cat > vaules.yaml << EOF +server: + ingress: + enabled: true + ingressClassName: "nginx" + hosts: + - host: vault.onwalk.net + paths: + - / + tls: + - secretName: vault-tls + hosts: + - vault.onwalk.net +EOF + +helm repo add hashicorp https://helm.releases.hashicorp.com +helm repo up +kubectl create ns vault || echo true +kubectl create secret tls vault-tls --key=/etc/ssl/onwalk.net.key --cert=/etc/ssl/onwalk.net.pem -n vault +helm upgrade --install vault-server hashicorp/vault -n vault --create-namespace -f vaules.yaml diff --git a/Solutions/Observability/example/yaml/update-nginx-tls.sh b/Solutions/Observability/example/yaml/update-nginx-tls.sh new file mode 100644 index 00000000..7a0d9f3b --- /dev/null +++ b/Solutions/Observability/example/yaml/update-nginx-tls.sh @@ -0,0 +1,11 @@ +kubectl delete secret nginx-tls -n nginx +kubectl create secret tls nginx-tls --key=/etc/ssl/onwalk.net.key --cert=/etc/ssl/onwalk.net.pem -n nginx + +kubectl delete secret svc-plus-tls -n nginx +kubectl create secret tls svc-plus-tls --key=/etc/ssl/svc.plus.key --cert=/etc/ssl/svc.plus.pem -n nginx + +kubectl delete secret svc-ink-tls -n nginx +kubectl create secret tls svc-ink-tls --key=/etc/ssl/svc.ink.key --cert=/etc/ssl/svc.ink.pem -n nginx + +kubectl delete secret vault-tls -n vault +kubectl create secret tls vault-tls --key=/etc/ssl/onwalk.net.key --cert=/etc/ssl/onwalk.net.pem -n vault diff --git a/Solutions/Observability/example/yaml/vaules.yaml b/Solutions/Observability/example/yaml/vaules.yaml new file mode 100644 index 00000000..867a634d --- /dev/null +++ b/Solutions/Observability/example/yaml/vaules.yaml @@ -0,0 +1,12 @@ +server: + ingress: + enabled: true + ingressClassName: "nginx" + hosts: + - host: vault.onwalk.net + paths: + - / + tls: + - secretName: vault-tls + hosts: + - vault.onwalk.net diff --git a/Solutions/aigc_app_engine b/Solutions/aigc_app_engine new file mode 160000 index 00000000..d3672141 --- /dev/null +++ b/Solutions/aigc_app_engine @@ -0,0 +1 @@ +Subproject commit d3672141cbe841efd755834587bfed10b31ab81b diff --git a/Solutions/containerd_platform/.github/workflows/iac-pipeline-destroy.yml b/Solutions/containerd_platform/.github/workflows/iac-pipeline-destroy.yml new file mode 100644 index 00000000..635330cc --- /dev/null +++ b/Solutions/containerd_platform/.github/workflows/iac-pipeline-destroy.yml @@ -0,0 +1,199 @@ +name: Destroy Resources by IAC tools + +env: + STATE: "destroy" # 可以根据需要更改初始状态, 可选create，update, destroy + CLOUD: "gcp" # 选择云服务商, 可选: gcp, aws, ali, azure + +on: + pull_request: + push: + paths: + - '.github/workflows/iac-pipeline-destroy.yml' + workflow_dispatch: + branches: + - main + +jobs: + gcs: + runs-on: ubuntu-latest + needs: + - vhost + - network + - key_pair + - firewall + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Set up Google Cloud SDK + uses: 'google-github-actions/setup-gcloud@v1' + with: + version: '>= 363.0.0' + + - name: Delete Google Cloud Storage Bucket + run: | + gsutil -m rm -r gs://iac_gcp_terraform_state || true + gcloud storage buckets delete gs://iac_gcp_terraform_state --quiet || true + network: + runs-on: ubuntu-latest + needs: + - vhost + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Terraform Init And Apply + run: | + bash run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/network/ + vhost: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Fetch SSH Keys + run: echo "${{ secrets.SSH_PUBLIC_KEY }}" > ssh_keys.pub + working-directory: iac_modules/terraform/${{ env.CLOUD }}/vhost/ + + - name: Terraform Init And Apply + run: | + python3 scripts/init.py && bash scripts/run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/vhost/ + + key_pair: + runs-on: ubuntu-latest + needs: + - vhost + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Set up Google Cloud SDK + uses: 'google-github-actions/setup-gcloud@v1' + with: + version: '>= 363.0.0' + + - name: Check if SSH Metadata exists + id: check_ssh_metadata + run: bash scripts/check_ssh_metadata.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/key_pair/ + + - name: Fetch SSH Keys + if: steps.check_ssh_metadata.outputs.ssh_metadata_exists == 'false' + run: echo "${{ secrets.SSH_PUBLIC_KEY }}" > ssh_keys.pub + working-directory: iac_modules/terraform/${{ env.CLOUD }}/key_pair/ + + - name: Terraform Init And Apply + if: steps.check_ssh_metadata.outputs.ssh_metadata_exists == 'false' + run: | + python3 scripts/init.py && bash scripts/run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/key_pair/ + + firewall: + runs-on: ubuntu-latest + needs: + - vhost + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Terraform Init And Apply + run: | + python3 scripts/init.py && bash scripts/run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/firewall/ diff --git a/Solutions/containerd_platform/.github/workflows/pipeline.yaml b/Solutions/containerd_platform/.github/workflows/pipeline.yaml new file mode 100644 index 00000000..90159db9 --- /dev/null +++ b/Solutions/containerd_platform/.github/workflows/pipeline.yaml @@ -0,0 +1,133 @@ +name: Sync And Deploy + +on: + pull_request: + push: + paths: + - '.github/workflows/pipieline.yaml' + workflow_dispatch: + branches: + - main + +defaults: + run: + working-directory: ./playbook + +env: + TZ: Asia/Shanghai + REPO: "artifact.onwalk.net" + IMAGE: base/${{ github.repository }} + TAG: ${{ github.sha }} + DNS_AK: ${{ secrets.DNS_AK }} + DNS_SK: ${{ secrets.DNS_SK }} + PASSWORD: ${{ secrets.ADMIN_INIT_PASSWORD }} + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Sync aritfacts + run: echo "to do" + + test: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Test aritfacts + run: echo "to do" + + setup-k3s: + runs-on: ubuntu-latest + needs: + - build + - test + + steps: + - uses: actions/checkout@v3 + + - name: update submodule + run: | + sudo apt-get update && sudo apt-get install -y git && git submodule update --init --recursive + + - name: Setup K3S Cluster + shell: bash + run: | + export ANSIBLE_HOST_KEY_CHECKING=False + sudo apt install jq ansible -y + + mkdir -pv ~/.ssh/ + cat > ~/.ssh/id_rsa << EOF + ${{ secrets.SSH_PRIVATE_KEY }} + EOF + sudo chmod 0400 ~/.ssh/id_rsa + md5sum ~/.ssh/id_rsa + + mkdir -pv hosts/ + cat > hosts/inventory << EOF + [master] + ${{ secrets.HOST_DOMAIN }} ansible_host=${{ secrets.HOST_IP }} + + [all:vars] + ansible_port=22 + ansible_ssh_user=${{ secrets.HOST_USER }} + ansible_ssh_private_key_file=~/.ssh/id_rsa + ansible_host_key_checking=False + ingress_ip=${{ secrets.HOST_IP }} + dns_ak=$DNS_AK + dns_sk=$DNS_SK + EOF + cat hosts/inventory + ansible-playbook -i hosts/inventory init_k3s_cluster_std -D + deploy-app: + runs-on: ubuntu-latest + needs: [setup-k3s] + + steps: + - uses: actions/checkout@v3 + + - name: update submodule + run: | + sudo apt-get update && sudo apt-get install -y git && git submodule update --init --recursive + + - name: Pre setup for Ansible playbook + run: | + sudo apt install jq ansible -y + + mkdir -pv ~/.ssh/ + cat > ~/.ssh/id_rsa << EOF + ${{ secrets.SSH_PRIVATE_KEY }} + EOF + sudo chmod 0400 ~/.ssh/id_rsa + md5sum ~/.ssh/id_rsa + + mkdir -pv hosts/ + cat > hosts/k3s << EOF + [master] + ${{ secrets.HOST_DOMAIN }} ansible_host=${{ secrets.HOST_IP }} + + [all:vars] + ansible_port=22 + ansible_ssh_user=${{ secrets.HOST_USER }} + ansible_ssh_private_key_file=~/.ssh/id_rsa + ansible_host_key_checking=False + admin_password=$PASSWORD + dns_ak=$DNS_AK + dns_sk=$DNS_SK + EOF + + - name: Deploy Keycloak + shell: bash + run: | + export ANSIBLE_HOST_KEY_CHECKING=False + ansible-playbook -i hosts/k3s init_keycloak -D + + - name: Deploy OpenLDAP + shell: bash + run: | + export ANSIBLE_HOST_KEY_CHECKING=False + ansible-playbook -i hosts/k3s init_openldap -D diff --git a/Solutions/containerd_platform/.github/workflows/pipeline.yml b/Solutions/containerd_platform/.github/workflows/pipeline.yml new file mode 100644 index 00000000..a1510304 --- /dev/null +++ b/Solutions/containerd_platform/.github/workflows/pipeline.yml @@ -0,0 +1,360 @@ +name: Create Resources by IAC tools + +env: + STATE: "create" # 可以根据需要更改初始状态, 可选create，update, destroy + CLOUD: "gcp" # 选择云服务商, 可选: gcp, aws, ali, azure + TZ: Asia/Shanghai + REPO: "artifact.onwalk.net" + IMAGE: base/${{ github.repository }} + TAG: ${{ github.sha }} + DNS_AK: ${{ secrets.DNS_AK }} + DNS_SK: ${{ secrets.DNS_SK }} + OSS_AK: ${{ secrets.OSS_AK }} + OSS_SK: ${{ secrets.OSS_SK }} + ROOT_PASSWORD: ${{ secrets.ADMIN_INIT_PASSWORD }} + SMTP_PASSWORD: ${{ secrets.SMTP_PASSWORD }} + GITLAB_OIDC_CLIENT_TOKEN: ${{ secrets.GITLAB_OIDC_CLIENT_TOKEN }} + HARBOR_OIDC_CLIENT_TOKEN: ${{ secrets.HARBOR_OIDC_CLIENT_TOKEN }} + SSH_USER: ${{ secrets.HOST_USER }} + SSH_HOST_DOMAIN: ${{ secrets.HOST_DOMAIN }} + SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }} + +on: + pull_request: + push: + paths: + - '.github/workflows/pipeline.yml' + workflow_dispatch: + branches: + - main + +jobs: + gcs: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Set up Google Cloud SDK + uses: 'google-github-actions/setup-gcloud@v1' + with: + version: '>= 363.0.0' + + - name: Check if GCS bucket exists + id: check_bucket + run: | + BUCKET_NAME="iac_gcp_terraform_state" + gsutil ls -b gs://${BUCKET_NAME} || echo "::set-output name=bucket_exists::false" + + - name: Terraform Init And Apply + if: steps.check_bucket.outputs.bucket_exists == 'false' + run: | + bash run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/gcs/ + network: + runs-on: ubuntu-latest + needs: + - gcs + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Terraform Init And Apply + run: | + bash run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/network/ + vhost: + runs-on: ubuntu-latest + needs: + - gcs + - network + - key_pair + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Fetch SSH Keys + run: echo "${{ secrets.SSH_PUBLIC_KEY }}" > ssh_keys.pub + working-directory: iac_modules/terraform/${{ env.CLOUD }}/vhost/ + + - name: Terraform Init And Apply + run: | + python3 scripts/init.py && bash scripts/run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/vhost/ + + key_pair: + runs-on: ubuntu-latest + needs: + - gcs + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Set up Google Cloud SDK + uses: 'google-github-actions/setup-gcloud@v1' + with: + version: '>= 363.0.0' + + - name: Check if SSH Metadata exists + id: check_ssh_metadata + run: bash scripts/check_ssh_metadata.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/key_pair/ + + - name: Fetch SSH Keys + if: steps.check_ssh_metadata.outputs.ssh_metadata_exists == 'false' + run: echo "${{ secrets.SSH_PUBLIC_KEY }}" > ssh_keys.pub + working-directory: iac_modules/terraform/${{ env.CLOUD }}/key_pair/ + + - name: Terraform Init And Apply + if: steps.check_ssh_metadata.outputs.ssh_metadata_exists == 'false' + run: | + python3 scripts/init.py && bash scripts/run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/key_pair/ + + firewall: + runs-on: ubuntu-latest + needs: + - gcs + - network + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Terraform Init And Apply + run: | + python3 scripts/init.py && bash scripts/run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/firewall/ + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Sync aritfacts + run: echo "to do" + + test: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Test aritfacts + run: echo "to do" + + setup-k3s: + runs-on: ubuntu-latest + needs: + - build + - test + - vhost + + steps: + - name: Checkout code + uses: actions/checkout@v3 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Set GitHub Actions output variables + id: terraform-output + run: | + python3 scripts/init.py && terraform init + terraform output | while read -r line; do + if [ -z "$line" ]; then + break + else + k_v=$(echo "$line" | tr -d ' ' | awk -F= '{print $1"="$2}') + echo "$k_v" >> $GITHUB_OUTPUT + fi + done + working-directory: iac_modules/terraform/${{ env.CLOUD }}/vhost/ + + - name: Update playbook hosts + run: | + bash pre_setup.sh + env: + SSH_HOST_IP: ${{ steps.terraform-output.outputs.server }} + working-directory: playbook/ + + - name: Setup K3S Cluster + shell: bash + run: | + export ANSIBLE_HOST_KEY_CHECKING=False + ansible-playbook -i hosts/inventory init_k3s_cluster_std -D + working-directory: playbook/ + deploy-Apps: + runs-on: ubuntu-latest + needs: + - setup-k3s + + steps: + - name: Checkout code + uses: actions/checkout@v3 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Set GitHub Actions output variables + id: terraform-output + run: | + python3 scripts/init.py && terraform init + terraform output | while read -r line; do + if [ -z "$line" ]; then + break + else + k_v=$(echo "$line" | tr -d ' ' | awk -F= '{print $1"="$2}') + echo "$k_v" >> $GITHUB_OUTPUT + fi + done + working-directory: iac_modules/terraform/${{ env.CLOUD }}/vhost/ + + - name: Update playbook hosts + run: | + bash pre_setup.sh + env: + SSH_HOST_IP: ${{ steps.terraform-output.outputs.server }} + working-directory: playbook/ + + - name: Deploy Gitlab + run: | + export ANSIBLE_HOST_KEY_CHECKING=False + ansible-playbook -i hosts/inventory init_gitlab -D + working-directory: playbook/ + + - name: Deploy Harbor + run: | + export ANSIBLE_HOST_KEY_CHECKING=False + ansible-playbook -i hosts/inventory init_harbor -D + working-directory: playbook/ + + - name: Deploy Chartmuseum + run: | + export ANSIBLE_HOST_KEY_CHECKING=False + ansible-playbook -i hosts/inventory init_chartmuseum -D + working-directory: playbook/ diff --git a/Solutions/containerd_platform/.gitmodules b/Solutions/containerd_platform/.gitmodules new file mode 100644 index 00000000..a4ef0241 --- /dev/null +++ b/Solutions/containerd_platform/.gitmodules @@ -0,0 +1,6 @@ +[submodule "iac_modules"] + path = iac_modules + url = https://github.com/svc-design/iac_modules.git +[submodule "playbook"] + path = playbook + url = https://github.com/svc-design/playbook.git diff --git a/Solutions/containerd_platform/LICENSE b/Solutions/containerd_platform/LICENSE new file mode 100644 index 00000000..f288702d --- /dev/null +++ b/Solutions/containerd_platform/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Solutions/containerd_platform/README.md b/Solutions/containerd_platform/README.md new file mode 100644 index 00000000..680810aa --- /dev/null +++ b/Solutions/containerd_platform/README.md @@ -0,0 +1,41 @@ +# 方案概述 + + +# CICD + +## 流水线配置文件 +配置文件位于 .github/workflows/pipeline.yaml 由三个阶段组成： + +1. 同步部署镜像：此阶段将同步chart包和应用镜像。 +3. 设置 K3s：此阶段在远程服务器上设置 K3s 集群。 +4. 部署应用：此阶段将chart包和应用镜像部署到 K3s 集群。 + +## 触发器 + +管道由以下事件触发： + +- 当打开或更新拉取请求时。 +- 当代码推送到主分支时。 +- 当工作流程手动调度时。 + +## 环境变量 + +Pipeline env: + +- TZ: 用于时间戳的时区。 +- REPO: 制品存储库的名称。 +- IMAGE: 要构建的 Docker 镜像的名称。 +- TAG: 要分配给 Docker 镜像的标签。 + +Actions secrets: + +- ADMIN_INIT_PASSWORD +- HELM_REPO_PASSWORD +- HELM_REPO_REGISTRY +- HELM_REPO_USER +- HOST_DOMAIN +- HOST_IP +- HOST_USER +- SSH_PRIVATE_KEY +- DNS_AK +- DNS_SK diff --git a/Solutions/devops/.github/workflows/iac-pipeline-destroy.yml b/Solutions/devops/.github/workflows/iac-pipeline-destroy.yml new file mode 100644 index 00000000..635330cc --- /dev/null +++ b/Solutions/devops/.github/workflows/iac-pipeline-destroy.yml @@ -0,0 +1,199 @@ +name: Destroy Resources by IAC tools + +env: + STATE: "destroy" # 可以根据需要更改初始状态, 可选create，update, destroy + CLOUD: "gcp" # 选择云服务商, 可选: gcp, aws, ali, azure + +on: + pull_request: + push: + paths: + - '.github/workflows/iac-pipeline-destroy.yml' + workflow_dispatch: + branches: + - main + +jobs: + gcs: + runs-on: ubuntu-latest + needs: + - vhost + - network + - key_pair + - firewall + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Set up Google Cloud SDK + uses: 'google-github-actions/setup-gcloud@v1' + with: + version: '>= 363.0.0' + + - name: Delete Google Cloud Storage Bucket + run: | + gsutil -m rm -r gs://iac_gcp_terraform_state || true + gcloud storage buckets delete gs://iac_gcp_terraform_state --quiet || true + network: + runs-on: ubuntu-latest + needs: + - vhost + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Terraform Init And Apply + run: | + bash run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/network/ + vhost: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Fetch SSH Keys + run: echo "${{ secrets.SSH_PUBLIC_KEY }}" > ssh_keys.pub + working-directory: iac_modules/terraform/${{ env.CLOUD }}/vhost/ + + - name: Terraform Init And Apply + run: | + python3 scripts/init.py && bash scripts/run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/vhost/ + + key_pair: + runs-on: ubuntu-latest + needs: + - vhost + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Set up Google Cloud SDK + uses: 'google-github-actions/setup-gcloud@v1' + with: + version: '>= 363.0.0' + + - name: Check if SSH Metadata exists + id: check_ssh_metadata + run: bash scripts/check_ssh_metadata.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/key_pair/ + + - name: Fetch SSH Keys + if: steps.check_ssh_metadata.outputs.ssh_metadata_exists == 'false' + run: echo "${{ secrets.SSH_PUBLIC_KEY }}" > ssh_keys.pub + working-directory: iac_modules/terraform/${{ env.CLOUD }}/key_pair/ + + - name: Terraform Init And Apply + if: steps.check_ssh_metadata.outputs.ssh_metadata_exists == 'false' + run: | + python3 scripts/init.py && bash scripts/run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/key_pair/ + + firewall: + runs-on: ubuntu-latest + needs: + - vhost + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Terraform Init And Apply + run: | + python3 scripts/init.py && bash scripts/run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/firewall/ diff --git a/Solutions/devops/.github/workflows/pipeline.yml b/Solutions/devops/.github/workflows/pipeline.yml new file mode 100644 index 00000000..a1510304 --- /dev/null +++ b/Solutions/devops/.github/workflows/pipeline.yml @@ -0,0 +1,360 @@ +name: Create Resources by IAC tools + +env: + STATE: "create" # 可以根据需要更改初始状态, 可选create，update, destroy + CLOUD: "gcp" # 选择云服务商, 可选: gcp, aws, ali, azure + TZ: Asia/Shanghai + REPO: "artifact.onwalk.net" + IMAGE: base/${{ github.repository }} + TAG: ${{ github.sha }} + DNS_AK: ${{ secrets.DNS_AK }} + DNS_SK: ${{ secrets.DNS_SK }} + OSS_AK: ${{ secrets.OSS_AK }} + OSS_SK: ${{ secrets.OSS_SK }} + ROOT_PASSWORD: ${{ secrets.ADMIN_INIT_PASSWORD }} + SMTP_PASSWORD: ${{ secrets.SMTP_PASSWORD }} + GITLAB_OIDC_CLIENT_TOKEN: ${{ secrets.GITLAB_OIDC_CLIENT_TOKEN }} + HARBOR_OIDC_CLIENT_TOKEN: ${{ secrets.HARBOR_OIDC_CLIENT_TOKEN }} + SSH_USER: ${{ secrets.HOST_USER }} + SSH_HOST_DOMAIN: ${{ secrets.HOST_DOMAIN }} + SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }} + +on: + pull_request: + push: + paths: + - '.github/workflows/pipeline.yml' + workflow_dispatch: + branches: + - main + +jobs: + gcs: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Set up Google Cloud SDK + uses: 'google-github-actions/setup-gcloud@v1' + with: + version: '>= 363.0.0' + + - name: Check if GCS bucket exists + id: check_bucket + run: | + BUCKET_NAME="iac_gcp_terraform_state" + gsutil ls -b gs://${BUCKET_NAME} || echo "::set-output name=bucket_exists::false" + + - name: Terraform Init And Apply + if: steps.check_bucket.outputs.bucket_exists == 'false' + run: | + bash run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/gcs/ + network: + runs-on: ubuntu-latest + needs: + - gcs + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Terraform Init And Apply + run: | + bash run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/network/ + vhost: + runs-on: ubuntu-latest + needs: + - gcs + - network + - key_pair + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Fetch SSH Keys + run: echo "${{ secrets.SSH_PUBLIC_KEY }}" > ssh_keys.pub + working-directory: iac_modules/terraform/${{ env.CLOUD }}/vhost/ + + - name: Terraform Init And Apply + run: | + python3 scripts/init.py && bash scripts/run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/vhost/ + + key_pair: + runs-on: ubuntu-latest + needs: + - gcs + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Set up Google Cloud SDK + uses: 'google-github-actions/setup-gcloud@v1' + with: + version: '>= 363.0.0' + + - name: Check if SSH Metadata exists + id: check_ssh_metadata + run: bash scripts/check_ssh_metadata.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/key_pair/ + + - name: Fetch SSH Keys + if: steps.check_ssh_metadata.outputs.ssh_metadata_exists == 'false' + run: echo "${{ secrets.SSH_PUBLIC_KEY }}" > ssh_keys.pub + working-directory: iac_modules/terraform/${{ env.CLOUD }}/key_pair/ + + - name: Terraform Init And Apply + if: steps.check_ssh_metadata.outputs.ssh_metadata_exists == 'false' + run: | + python3 scripts/init.py && bash scripts/run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/key_pair/ + + firewall: + runs-on: ubuntu-latest + needs: + - gcs + - network + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Terraform Init And Apply + run: | + python3 scripts/init.py && bash scripts/run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/firewall/ + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Sync aritfacts + run: echo "to do" + + test: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Test aritfacts + run: echo "to do" + + setup-k3s: + runs-on: ubuntu-latest + needs: + - build + - test + - vhost + + steps: + - name: Checkout code + uses: actions/checkout@v3 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Set GitHub Actions output variables + id: terraform-output + run: | + python3 scripts/init.py && terraform init + terraform output | while read -r line; do + if [ -z "$line" ]; then + break + else + k_v=$(echo "$line" | tr -d ' ' | awk -F= '{print $1"="$2}') + echo "$k_v" >> $GITHUB_OUTPUT + fi + done + working-directory: iac_modules/terraform/${{ env.CLOUD }}/vhost/ + + - name: Update playbook hosts + run: | + bash pre_setup.sh + env: + SSH_HOST_IP: ${{ steps.terraform-output.outputs.server }} + working-directory: playbook/ + + - name: Setup K3S Cluster + shell: bash + run: | + export ANSIBLE_HOST_KEY_CHECKING=False + ansible-playbook -i hosts/inventory init_k3s_cluster_std -D + working-directory: playbook/ + deploy-Apps: + runs-on: ubuntu-latest + needs: + - setup-k3s + + steps: + - name: Checkout code + uses: actions/checkout@v3 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Set GitHub Actions output variables + id: terraform-output + run: | + python3 scripts/init.py && terraform init + terraform output | while read -r line; do + if [ -z "$line" ]; then + break + else + k_v=$(echo "$line" | tr -d ' ' | awk -F= '{print $1"="$2}') + echo "$k_v" >> $GITHUB_OUTPUT + fi + done + working-directory: iac_modules/terraform/${{ env.CLOUD }}/vhost/ + + - name: Update playbook hosts + run: | + bash pre_setup.sh + env: + SSH_HOST_IP: ${{ steps.terraform-output.outputs.server }} + working-directory: playbook/ + + - name: Deploy Gitlab + run: | + export ANSIBLE_HOST_KEY_CHECKING=False + ansible-playbook -i hosts/inventory init_gitlab -D + working-directory: playbook/ + + - name: Deploy Harbor + run: | + export ANSIBLE_HOST_KEY_CHECKING=False + ansible-playbook -i hosts/inventory init_harbor -D + working-directory: playbook/ + + - name: Deploy Chartmuseum + run: | + export ANSIBLE_HOST_KEY_CHECKING=False + ansible-playbook -i hosts/inventory init_chartmuseum -D + working-directory: playbook/ diff --git a/Solutions/devops/.gitmodules b/Solutions/devops/.gitmodules new file mode 100644 index 00000000..7da8375f --- /dev/null +++ b/Solutions/devops/.gitmodules @@ -0,0 +1,6 @@ +[submodule "playbook"] + path = playbook + url = https://github.com/svc-design/playbook.git +[submodule "iac_modules"] + path = iac_modules + url = https://github.com/svc-design/iac_modules.git diff --git a/Solutions/devops/LICENSE b/Solutions/devops/LICENSE new file mode 100644 index 00000000..f288702d --- /dev/null +++ b/Solutions/devops/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Solutions/devops/README.md b/Solutions/devops/README.md new file mode 100644 index 00000000..b6f2f2bb --- /dev/null +++ b/Solutions/devops/README.md @@ -0,0 +1,96 @@ +# DevOPSPlatform + +该解决方案使用 Gitlab, Harbor,ChartMuseum 等开源软件，构建的DevOPS平台解决方案通过 GitHub Actions 自动交付创建服务。 + +- IacOPS +- MLOPS +- DevSecOPS +- ChosOPS + +# 架构图 + +![请在此添加图片描述](https://developer.qcloudimg.com/http-save/yehe-2810186/a4bab250e17d279a9a09c794249a09d6.png?qc_blockWidth=620&qc_blockHeight=435) + +该解决方案使用以下开源软件： + +- Gitlab +- Harbor/ + + +# CICD +流水线配置文件 +配置文件位于 .github/workflows/pipeline.yaml 由四个阶段组成： + +- 构建测试：此阶段从源代码构建 APP, 并运行测试套件，以确保APP 正常工作。 +- Docker 镜像：此阶段构建一个包含 APP 的 Docker 镜像。 +- 设置 K3s：此阶段在远程服务器上设置 K3s 集群。 +- 部署应用：此阶段将 APP 部署到 K3s 集群。 + +# Playook 角色说明 + +DevOPSPlatform 配置库由以下角色组成： + +- app 应用程序服务角色，提供应用程序运行所需的服务，如 Nginx、Docker、MySQL、Redis 等。 +- chartmuseum 图表仓库角色，用于存储和管理 Kubernetes 图表。 +- gitlab 代码仓库角色，用于存储和管理代码。 +- k3s Kubernetes 集群角色，用于管理 Kubernetes 集群。 +- k3s-reset Kubernetes 集群重置角色，用于重置 Kubernetes 集群。 +- postgresql PostgreSQL 数据库角色，用于提供 PostgreSQL 数据库服务。 +- secret-manger 密钥管理角色，用于管理密钥。 +- cert-manager 证书管理角色，用于管理证书。 +- common 通用角色，包含一些常用的功能，如日志记录、监控等。 +- harbor 容器镜像仓库角色，用于存储和管理容器镜像。 +- k3s-addon Kubernetes 集群插件角色，用于安装 Kubernetes 集群插件。 +- mysql MySQL 数据库角色，用于提供 MySQL 数据库服务。 +- redis Redis 数据库角色，用于提供 Redis 数据库服务。 + +## 触发器 +管道由以下事件触发： + +- 当打开或更新拉取请求时。 +- 当代码推送到主分支时。 +- 当工作流程手动调度时。 + +## 环境变量 + +在YAML文件或CI/CD流水线配置中定义的ENV变量： + +- TZ: Asia/Shanghai：设置时区为Asia/Shanghai。 +- REPO: "artifact.onwalk.net"：指定一个存储库的URL或标识符。 +- IMAGE: base/${{ github.repository }}：基于GitHub存储库构建一个容器镜像名称。 +- TAG: ${{ github.sha }}：将镜像标签设置为GitHub存储库的提交SHA。 +- DNS_AK: ${{ secrets.DNS_AK }}：使用GitHub的密钥设置阿里云DNS访问密钥。 +- DNS_SK: ${{ secrets.DNS_SK }}：使用GitHub的密钥设置阿里云DNS密钥。 +- DEBIAN_FRONTEND: noninteractive：将Debian前端设置为非交互模式，这在自动化脚本中很有用，可防止交互提示。 +- HELM_EXPERIMENTAL_OCI: 1：启用Helm中的实验性OCI（Open Container Initiative）支持，允许Helm与OCI镜像一起使用。 + +如需在自己的账号运行这个Demo，只需要将 https://github.com/open-source-solution-design/ObservabilityPlatform.git 这个仓库Fork 到你自己的Github账号下，同时在 + +Settings -> Actions secrets and variables: 添加流水线需要定义的 secrets 变量 + +Server 相关 secrets 变量 + +- HELM_REPO_USER Artifact 仓库认证用户名 +- HELM_REPO_REGISTRY Artifact 仓库认证地址 +- HELM_REPO_PASSWORD Artifact 仓库认证密码 +- HOST_USER 部署K3S的主机OS登陆用户名 +- HOST_IP 部署K3S的主机IP地址 +- HOST_DOMAIN 部署K3S的主机域名 +- SSH_PRIVATE_KEY 访问K3S的主机的SSH 私钥 +- DNS_AK 阿里云DNS 服务 AK (用于自动签发SSL证书和更新解析记录，发布ingress ) +- DNS_SK 阿里云DNS 服务 SK (用于自动签发SSL证书和更新解析记录，发布ingress ) + + +# Ingress Endpoint + +| name | URI | +| --- | --- | +| | | + +# Repo Init + +git submodule add https://github.com/svc-design/iac_modules.git iac_modules +git submodule add https://github.com/svc-design/playbook.git playbook +git submodule init +git submodule update +git submodule update --init --recursive diff --git a/Solutions/micro_service b/Solutions/micro_service new file mode 160000 index 00000000..7c682a3a --- /dev/null +++ b/Solutions/micro_service @@ -0,0 +1 @@ +Subproject commit 7c682a3ae5107b61fe5d7e68cfe282b7f86cf0c5 diff --git a/Solutions/sso_identity_provider/.github/workflows/iac-pipeline-destroy.yml b/Solutions/sso_identity_provider/.github/workflows/iac-pipeline-destroy.yml new file mode 100644 index 00000000..635330cc --- /dev/null +++ b/Solutions/sso_identity_provider/.github/workflows/iac-pipeline-destroy.yml @@ -0,0 +1,199 @@ +name: Destroy Resources by IAC tools + +env: + STATE: "destroy" # 可以根据需要更改初始状态, 可选create，update, destroy + CLOUD: "gcp" # 选择云服务商, 可选: gcp, aws, ali, azure + +on: + pull_request: + push: + paths: + - '.github/workflows/iac-pipeline-destroy.yml' + workflow_dispatch: + branches: + - main + +jobs: + gcs: + runs-on: ubuntu-latest + needs: + - vhost + - network + - key_pair + - firewall + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Set up Google Cloud SDK + uses: 'google-github-actions/setup-gcloud@v1' + with: + version: '>= 363.0.0' + + - name: Delete Google Cloud Storage Bucket + run: | + gsutil -m rm -r gs://iac_gcp_terraform_state || true + gcloud storage buckets delete gs://iac_gcp_terraform_state --quiet || true + network: + runs-on: ubuntu-latest + needs: + - vhost + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Terraform Init And Apply + run: | + bash run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/network/ + vhost: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Fetch SSH Keys + run: echo "${{ secrets.SSH_PUBLIC_KEY }}" > ssh_keys.pub + working-directory: iac_modules/terraform/${{ env.CLOUD }}/vhost/ + + - name: Terraform Init And Apply + run: | + python3 scripts/init.py && bash scripts/run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/vhost/ + + key_pair: + runs-on: ubuntu-latest + needs: + - vhost + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Set up Google Cloud SDK + uses: 'google-github-actions/setup-gcloud@v1' + with: + version: '>= 363.0.0' + + - name: Check if SSH Metadata exists + id: check_ssh_metadata + run: bash scripts/check_ssh_metadata.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/key_pair/ + + - name: Fetch SSH Keys + if: steps.check_ssh_metadata.outputs.ssh_metadata_exists == 'false' + run: echo "${{ secrets.SSH_PUBLIC_KEY }}" > ssh_keys.pub + working-directory: iac_modules/terraform/${{ env.CLOUD }}/key_pair/ + + - name: Terraform Init And Apply + if: steps.check_ssh_metadata.outputs.ssh_metadata_exists == 'false' + run: | + python3 scripts/init.py && bash scripts/run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/key_pair/ + + firewall: + runs-on: ubuntu-latest + needs: + - vhost + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Terraform Init And Apply + run: | + python3 scripts/init.py && bash scripts/run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/firewall/ diff --git a/Solutions/sso_identity_provider/.github/workflows/pipeline.yml b/Solutions/sso_identity_provider/.github/workflows/pipeline.yml new file mode 100644 index 00000000..160b68c1 --- /dev/null +++ b/Solutions/sso_identity_provider/.github/workflows/pipeline.yml @@ -0,0 +1,354 @@ +name: Create Resources by IAC tools + +env: + STATE: "create" # 可以根据需要更改初始状态, 可选create，update, destroy + CLOUD: "gcp" # 选择云服务商, 可选: gcp, aws, ali, azure + TZ: Asia/Shanghai + REPO: "artifact.onwalk.net" + IMAGE: base/${{ github.repository }} + TAG: ${{ github.sha }} + DNS_AK: ${{ secrets.DNS_AK }} + DNS_SK: ${{ secrets.DNS_SK }} + OSS_AK: ${{ secrets.OSS_AK }} + OSS_SK: ${{ secrets.OSS_SK }} + ROOT_PASSWORD: ${{ secrets.ADMIN_INIT_PASSWORD }} + SMTP_PASSWORD: ${{ secrets.SMTP_PASSWORD }} + GITLAB_OIDC_CLIENT_TOKEN: ${{ secrets.GITLAB_OIDC_CLIENT_TOKEN }} + HARBOR_OIDC_CLIENT_TOKEN: ${{ secrets.HARBOR_OIDC_CLIENT_TOKEN }} + SSH_USER: ${{ secrets.HOST_USER }} + SSH_HOST_DOMAIN: ${{ secrets.HOST_DOMAIN }} + SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }} + +on: + pull_request: + push: + paths: + - '.github/workflows/pipeline.yml' + workflow_dispatch: + branches: + - main + +jobs: + gcs: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Set up Google Cloud SDK + uses: 'google-github-actions/setup-gcloud@v1' + with: + version: '>= 363.0.0' + + - name: Check if GCS bucket exists + id: check_bucket + run: | + BUCKET_NAME="iac_gcp_terraform_state" + gsutil ls -b gs://${BUCKET_NAME} || echo "::set-output name=bucket_exists::false" + + - name: Terraform Init And Apply + if: steps.check_bucket.outputs.bucket_exists == 'false' + run: | + bash run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/gcs/ + network: + runs-on: ubuntu-latest + needs: + - gcs + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Terraform Init And Apply + run: | + bash run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/network/ + vhost: + runs-on: ubuntu-latest + needs: + - gcs + - network + - key_pair + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Fetch SSH Keys + run: echo "${{ secrets.SSH_PUBLIC_KEY }}" > ssh_keys.pub + working-directory: iac_modules/terraform/${{ env.CLOUD }}/vhost/ + + - name: Terraform Init And Apply + run: | + python3 scripts/init.py && bash scripts/run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/vhost/ + + key_pair: + runs-on: ubuntu-latest + needs: + - gcs + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Set up Google Cloud SDK + uses: 'google-github-actions/setup-gcloud@v1' + with: + version: '>= 363.0.0' + + - name: Check if SSH Metadata exists + id: check_ssh_metadata + run: bash scripts/check_ssh_metadata.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/key_pair/ + + - name: Fetch SSH Keys + if: steps.check_ssh_metadata.outputs.ssh_metadata_exists == 'false' + run: echo "${{ secrets.SSH_PUBLIC_KEY }}" > ssh_keys.pub + working-directory: iac_modules/terraform/${{ env.CLOUD }}/key_pair/ + + - name: Terraform Init And Apply + if: steps.check_ssh_metadata.outputs.ssh_metadata_exists == 'false' + run: | + python3 scripts/init.py && bash scripts/run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/key_pair/ + + firewall: + runs-on: ubuntu-latest + needs: + - gcs + - network + + steps: + - name: Checkout code + uses: actions/checkout@v2 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Terraform Init And Apply + run: | + python3 scripts/init.py && bash scripts/run_terraform.sh + working-directory: iac_modules/terraform/${{ env.CLOUD }}/firewall/ + build: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Sync aritfacts + run: echo "to do" + + test: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + + - name: Test aritfacts + run: echo "to do" + + setup-k3s: + runs-on: ubuntu-latest + needs: + - build + - test + - vhost + + steps: + - name: Checkout code + uses: actions/checkout@v3 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Set GitHub Actions output variables + id: terraform-output + run: | + python3 scripts/init.py && terraform init + terraform output | while read -r line; do + if [ -z "$line" ]; then + break + else + k_v=$(echo "$line" | tr -d ' ' | awk -F= '{print $1"="$2}') + echo "$k_v" >> $GITHUB_OUTPUT + fi + done + working-directory: iac_modules/terraform/${{ env.CLOUD }}/vhost/ + + - name: Update playbook hosts + run: | + bash pre_setup.sh + env: + SSH_HOST_IP: ${{ steps.terraform-output.outputs.server }} + working-directory: playbook/ + + - name: Setup K3S Cluster + shell: bash + run: | + export ANSIBLE_HOST_KEY_CHECKING=False + ansible-playbook -i hosts/inventory init_k3s_cluster_std -D + working-directory: playbook/ + deploy-Apps: + runs-on: ubuntu-latest + needs: + - setup-k3s + + steps: + - name: Checkout code + uses: actions/checkout@v3 + with: + submodules: 'recursive' + + - name: Pre Setup + run: | + sudo apt-get update + sudo apt-get install -y python3-pip jq + python -m pip install --upgrade pip jinja2 + + - name: Set up Terraform + uses: hashicorp/setup-terraform@v1 + with: + terraform_version: 1.6.4 + + - name: Authenticate with Google Cloud + uses: google-github-actions/auth@v1 + with: + credentials_json: ${{ secrets.GCP_CREDENTIALS_JSON }} + + - name: Set GitHub Actions output variables + id: terraform-output + run: | + python3 scripts/init.py && terraform init + terraform output | while read -r line; do + if [ -z "$line" ]; then + break + else + k_v=$(echo "$line" | tr -d ' ' | awk -F= '{print $1"="$2}') + echo "$k_v" >> $GITHUB_OUTPUT + fi + done + working-directory: iac_modules/terraform/${{ env.CLOUD }}/vhost/ + + - name: Update playbook hosts + run: | + bash pre_setup.sh + env: + SSH_HOST_IP: ${{ steps.terraform-output.outputs.server }} + working-directory: playbook/ + + - name: Deploy Keycloak + run: | + export ANSIBLE_HOST_KEY_CHECKING=False + ansible-playbook -i hosts/inventory init_keycloak -D + working-directory: playbook/ + + - name: Deploy Openldap + run: | + export ANSIBLE_HOST_KEY_CHECKING=False + ansible-playbook -i hosts/inventory init_openldap -D + working-directory: playbook/ diff --git a/Solutions/sso_identity_provider/.gitmodules b/Solutions/sso_identity_provider/.gitmodules new file mode 100644 index 00000000..a4ef0241 --- /dev/null +++ b/Solutions/sso_identity_provider/.gitmodules @@ -0,0 +1,6 @@ +[submodule "iac_modules"] + path = iac_modules + url = https://github.com/svc-design/iac_modules.git +[submodule "playbook"] + path = playbook + url = https://github.com/svc-design/playbook.git diff --git a/Solutions/sso_identity_provider/LICENSE b/Solutions/sso_identity_provider/LICENSE new file mode 100644 index 00000000..f288702d --- /dev/null +++ b/Solutions/sso_identity_provider/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Solutions/sso_identity_provider/README.md b/Solutions/sso_identity_provider/README.md new file mode 100644 index 00000000..680810aa --- /dev/null +++ b/Solutions/sso_identity_provider/README.md @@ -0,0 +1,41 @@ +# 方案概述 + + +# CICD + +## 流水线配置文件 +配置文件位于 .github/workflows/pipeline.yaml 由三个阶段组成： + +1. 同步部署镜像：此阶段将同步chart包和应用镜像。 +3. 设置 K3s：此阶段在远程服务器上设置 K3s 集群。 +4. 部署应用：此阶段将chart包和应用镜像部署到 K3s 集群。 + +## 触发器 + +管道由以下事件触发： + +- 当打开或更新拉取请求时。 +- 当代码推送到主分支时。 +- 当工作流程手动调度时。 + +## 环境变量 + +Pipeline env: + +- TZ: 用于时间戳的时区。 +- REPO: 制品存储库的名称。 +- IMAGE: 要构建的 Docker 镜像的名称。 +- TAG: 要分配给 Docker 镜像的标签。 + +Actions secrets: + +- ADMIN_INIT_PASSWORD +- HELM_REPO_PASSWORD +- HELM_REPO_REGISTRY +- HELM_REPO_USER +- HOST_DOMAIN +- HOST_IP +- HOST_USER +- SSH_PRIVATE_KEY +- DNS_AK +- DNS_SK