docs: updated README.md for docker folder (#5016) #6667
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Docs for the Azure Web Apps Deploy action: https://github.com/Azure/webapps-deploy | |
| # More GitHub Actions for Azure: https://github.com/Azure/actions | |
| name: CIs | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - develop | |
| - "feat/**" | |
| pull_request: | |
| workflow_dispatch: | |
| env: | |
| CI: true | |
| PNPM_CACHE_FOLDER: .pnpm-store | |
| # set default for ACR variables | |
| ACR_ENDPOINT: ${{ secrets.ACR_ENDPOINT || 'dummy' }} | |
| ACR_USERNAME: ${{ secrets.ACR_USERNAME || '' }} | |
| ACR_PASSWORD: ${{ secrets.ACR_PASSWORD || '' }} | |
| jobs: | |
| changes: | |
| name: checking file changes | |
| runs-on: ubuntu-latest | |
| outputs: | |
| geohub: ${{ steps.changes.outputs.geohub }} | |
| docs: ${{ steps.changes.outputs.docs }} | |
| undpdesign: ${{ steps.changes.outputs.undpdesign }} | |
| undpcomponents: ${{ steps.changes.outputs.undpcomponents }} | |
| staticapi: ${{ steps.changes.outputs.staticapi }} | |
| pgtileserv: ${{ steps.changes.outputs.pgtileserv }} | |
| datapipeline: ${{ steps.changes.outputs.datapipeline }} | |
| cogserver-dev: ${{ steps.changes.outputs.cogserver-dev }} | |
| cogserver: ${{ steps.changes.outputs.cogserver }} | |
| stacpipeline: ${{ steps.changes.outputs.stacpipeline }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dorny/paths-filter@v3 | |
| id: changes | |
| with: | |
| base: ${{ github.ref }} | |
| filters: | | |
| geohub: | |
| - 'sites/geohub/**' | |
| - 'packages/**' | |
| - '.github/workflows/ci.yml' | |
| - '.github/workflows/release.yml' | |
| - 'package.json' | |
| - 'pnpm-lock.yaml' | |
| - 'pnpm-workspace.yaml' | |
| - ./docker/Dockerfile.production | |
| docs: | |
| - 'documentation/**' | |
| - '.github/workflows/ci.yml' | |
| undpdesign: | |
| - 'packages/svelte-undp-design/**' | |
| - 'package.json' | |
| - 'pnpm-lock.yaml' | |
| - '.github/workflows/ci.yml' | |
| undpcomponents: | |
| - 'packages/svelte-undp-components/**' | |
| - 'package.json' | |
| - 'pnpm-lock.yaml' | |
| - '.github/workflows/ci.yml' | |
| staticapi: | |
| - 'sites/static-image-api/**' | |
| - '.github/workflows/ci.yml' | |
| pgtileserv: | |
| - 'backends/k8s/pgtileserv/**' | |
| - '.github/workflows/ci.yml' | |
| datapipeline: | |
| - 'backends/k8s/data-pipeline/yaml/ingest-environment.yaml' | |
| - '.github/workflows/bump-pipeline.yml' | |
| - '.github/workflows/ci.yml' | |
| cogserver-dev: | |
| - 'backends/k8s/cogserver/yaml/cogserver-dev-deployment.yaml' | |
| - '.github/workflows/bump-cogserver.yml' | |
| - '.github/workflows/ci.yml' | |
| cogserver: | |
| - 'backends/k8s/cogserver/yaml/cogserver-deployment.yaml' | |
| - '.github/workflows/bump-cogserver.yml' | |
| - '.github/workflows/ci.yml' | |
| stacpipeline: | |
| - 'backends/k8s/stac-pipeline/yaml/deployment.yaml' | |
| - '.github/workflows/ci.yml' | |
| lint_build: | |
| name: lint, build and test for GeoHub | |
| needs: changes | |
| if: ${{ needs.changes.outputs.geohub == 'true' }} | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| node-version: [22] | |
| steps: | |
| - name: checkout code repository | |
| uses: actions/checkout@v4 | |
| - uses: pnpm/action-setup@v4.1.0 | |
| - name: Setup Node.js ${{ matrix.node-version }} | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: ${{ matrix.node-version }} | |
| cache: pnpm | |
| - name: install dependencies | |
| run: pnpm install --frozen-lockfile | |
| - name: Run Prettier | |
| run: pnpm format | |
| - name: Run lint | |
| run: pnpm lint | |
| - name: build | |
| run: pnpm build | |
| - name: Run unit tests | |
| run: pnpm test | |
| build-docker: | 8000|
| name: Build & Deploy Docker Image | |
| needs: changes | |
| if: ${{ github.repository == 'undp-data/geohub' && needs.changes.outputs.geohub == 'true' }} | |
| runs-on: ubuntu-latest | |
| env: | |
| IMAGE_NAME: undp-data/geohub | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Log into ACR | |
| uses: docker/login-action@v3 | |
| if: ${{ env.ACR_USERNAME != '' && env.ACR_PASSWORD != ''}} | |
| with: | |
| registry: ${{ env.ACR_ENDPOINT }} | |
| username: ${{ env.ACR_USERNAME }} | |
| password: ${{ env.ACR_PASSWORD }} | |
| - name: Extract Docker metadata | |
| id: meta | |
| uses: docker/metadata-action@v5 | |
| with: | |
| images: ${{ env.ACR_ENDPOINT }}/${{ env.IMAGE_NAME }} | |
| - name: Build and push | |
| uses: docker/build-push-action@v6 | |
| with: | |
| context: . | |
| file: ./docker/Dockerfile.production | |
| # push docker image only for main branch and branch name starts with `develop` | |
| # also push docker image for branches named like `feat/` | |
| push: ${{ github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/heads/develop') || startsWith(github.ref, 'refs/heads/feat/') }} | |
| tags: ${{ steps.meta.outputs.tags }} | |
| labels: ${{ steps.meta.outputs.labels }} | |
| build-and-deploy-undp-design: | |
| name: Build and deploy svelte UNDP design storybook | |
| needs: changes | |
| if: ${{ needs.changes.outputs.undpdesign == 'true' }} | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| node-version: [22] | |
| environment: | |
| name: Svelte UNDP Design | |
| url: https://svelte-undp-design.undpgeohub.org/ | |
| steps: | |
| - name: checkout code repository | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: pnpm/action-setup@v4.1.0 | |
| - name: Setup Node.js ${{ matrix.node-version }} | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: ${{ matrix.node-version }} | |
| cache: pnpm | |
| - name: install dependencies | |
| run: pnpm install --frozen-lockfile | |
| - name: build storybook | |
| run: | | |
| pnpm --filter="./packages/undp-bulma" build | |
| pnpm --filter="./packages/svelte-undp-design" build | |
| pnpm --filter="./packages/svelte-undp-design" build-storybook | |
| - name: deploy storybook to Blob container | |
| if: ${{ (github.ref == 'refs/heads/develop') }} | |
| uses: azure/CLI@v2 | |
| with: | |
| azcliversion: 2.67.0 | |
| # azcopy workadound https://github.com/Azure/azure-cli/issues/30635 | |
| inlineScript: | | |
| tdnf install -y azcopy; | |
| az storage blob sync \ | |
| --container '$web' \ | |
| --source "packages/svelte-undp-design/storybook-static" \ | |
| --connection-string "${{ secrets.AZURE_STORAGE_CONNECTION_STRING_STORYBOOK }}" \ | |
| --delete-destination true | |
| build-and-deploy-undp-components: | |
| name: Build and deploy svelte UNDP components storybook | |
| needs: changes | |
| if: ${{ needs.changes.outputs.undpcomponents == 'true' }} | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| node-version: [22] | |
| environment: | |
| name: Svelte UNDP Components | |
| url: https://svelte-undp-components.undpgeohub.org/ | |
| steps: | |
| - name: checkout code repository | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: pnpm/action-setup@v4.1.0 | |
| - name: Setup Node.js ${{ matrix.node-version }} | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: ${{ matrix.node-version }} | |
| cache: pnpm | |
| - name: install dependencies | |
| run: pnpm install --frozen-lockfile | |
| - name: build storybook | |
| run: | | |
| pnpm --filter="./packages/undp-bulma" build | |
| pnpm --filter="./packages/svelte-undp-design" build | |
| pnpm --filter="./packages/svelte-undp-components" build | |
| pnpm --filter="./packages/svelte-undp-components" build-storybook | |
| - name: deploy storybook to Blob container | |
| if: ${{ (github.ref == 'refs/heads/develop') }} | |
| uses: azure/CLI@v2 | |
| with: | |
| azcliversion: 2.67.0 | |
| # azcopy workadound https://github.com/Azure/azure-cli/issues/30635 | |
| inlineScript: | | |
| tdnf install -y azcopy; | |
| az storage blob sync \ | |
| --container '$web' \ | |
| --source "packages/svelte-undp-components/storybook-static" \ | |
| --connection-string "${{ secrets.AZURE_STORAGE_CONNECTION_STRING_STORYBOOK }}" \ | |
| --delete-destination true | |
| build-and-deploy-userguide: | |
| name: Build and deploy GeoHub userguide | |
| 8000 | needs: changes |
| if: ${{ needs.changes.outputs.docs == 'true' }} | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: GeoHub UserGuide | |
| steps: | |
| - name: checkout code repository | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@v5 | |
| - name: Install dependecies | |
| working-directory: ./documentation | |
| run: | | |
| apt-get update && apt-get upgrade -y && apt-get install -y libcairo2 | |
| pip install --upgrade pip | |
| pip install -r requirements.txt | |
| - name: Extract branch name | |
| shell: bash | |
| run: echo "branch=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}" >> $GITHUB_OUTPUT | |
| id: extract_branch | |
| - name: Copy and generate markdown file for slides | |
| working-directory: ./documentation | |
| run: python generate-slides.py | |
| - name: Build documentation for production | |
| if: ${{ (github.ref == 'refs/heads/main') }} | |
| working-directory: ./documentation | |
| env: | |
| SITE_URL: https://docs.undpgeohub.org | |
| EDIT_URL: https://github.com/undp-data/geohub/blob/${{ steps.extract_branch.outputs.branch }}/documentation/docs | |
| run: mkdocs build | |
| - name: Build documentation for dev | |
| if: ${{ (github.ref != 'refs/heads/main') }} | |
| working-directory: ./documentation | |
| env: | |
| SITE_URL: https://docs-dev.undpgeohub.org | |
| EDIT_URL: https://github.com/undp-data/geohub/blob/${{ steps.extract_branch.outputs.branch }}/documentation/docs | |
| run: mkdocs build | |
| - name: deploy userguide to Blob container Prod | |
| if: ${{ (github.ref == 'refs/heads/main') }} | |
| uses: azure/CLI@v2 | |
| with: | |
| azcliversion: 2.67.0 | |
| # azcopy workadound https://github.com/Azure/azure-cli/issues/30635 | |
| inlineScript: | | |
| tdnf install -y azcopy; | |
| az storage blob sync \ | |
| --container '$web' \ | |
| --source "documentation/site" \ | |
| --connection-string "${{ secrets.AZURE_STORAGE_CONNECTION_STRING_USERGUIDE }}" \ | |
| --delete-destination true | |
| - name: deploy userguide to Blob container Dev | |
| if: ${{ github.ref == 'refs/heads/develop' }} | |
| uses: azure/CLI@v2 | |
| with: | |
| azcliversion: 2.67.0 | |
| # azcopy workadound https://github.com/Azure/azure-cli/issues/30635 | |
| inlineScript: | | |
| tdnf install -y azcopy; | |
| az storage blob sync \ | |
| --container '$web' \ | |
| --source "documentation/site" \ | |
| --connection-string "${{ secrets.AZURE_STORAGE_CONNECTION_STRING_USERGUIDE_DEV }}" \ | |
| --delete-destination true | |
| build_static_api_acr: | |
| name: Build and deploy Static Image API to ACR | |
| needs: changes | |
| if: ${{ github.repository == 'undp-data/geohub' && needs.changes.outputs.staticapi == 'true' }} | |
| runs-on: ubuntu-24.04 | |
| environment: | |
| name: Static Image API | |
| url: https://staticimage.undpgeohub.org | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Log into ACR | |
| uses: docker/login-action@v3 | |
| if: ${{ env.ACR_USERNAME != '' && env.ACR_PASSWORD != ''}} | |
| with: | |
| registry: ${{ env.ACR_ENDPOINT }} | |
| username: ${{ env.ACR_USERNAME }} | |
| password: ${{ env.ACR_PASSWORD }} | |
| - name: Extract Docker metadata | |
| id: meta | |
| uses: docker/metadata-action@v5 | |
| with: | |
| images: ${{ env.ACR_ENDPOINT }}/${{ vars.IMAGE_NAME }} | |
| - name: Build and push | |
| uses: docker/build-push-action@v6 | |
| with: | |
| context: ./sites/static-image-api | |
| push: ${{ github.ref == 'refs/heads/develop'}} | |
| tags: ${{ steps.meta.outputs.tags }} | |
| labels: ${{ steps.meta.outputs.labels }} | |
| build_static_api_ghcr: | |
| name: Build and deploy Static Image API to GitHub Package | |
| needs: changes | |
| if: ${{ needs.changes.outputs.staticapi == 'true' }} | |
| runs-on: ubuntu-24.04 | |
| environment: | |
| name: Static Image API | |
| url: https://staticimage.undpgeohub.org | |
| env: | |
| REGISTRY: ghcr.io | |
| IMAGE_NAME: ${{ github.repository_owner }}/${{ vars.IMAGE_NAME }} | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Log into GHCR | |
| uses: docker/login-action@v3 | |
| with: | |
| registry: ${{ env.REGISTRY }} | |
| username: ${{ github.actor }} | |
| password: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Extract metadata (tags, labels) for Docker | |
| id: meta | |
| uses: docker/metadata-action@v5 | |
| 8000 | with: |
| images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} | |
| - name: Build and push Docker image | |
| uses: docker/build-push-action@v6 | |
| with: | |
| context: ./sites/static-image-api | |
| push: ${{ github.ref == 'refs/heads/develop'}} | |
| tags: ${{ steps.meta.outputs.tags }} | |
| labels: ${{ steps.meta.outputs.labels }} | |
| k8s_pgtileserv_deploy: | |
| name: Deploy pg_tileserv to Kubernetes | |
| needs: changes | |
| if: ${{ github.ref == 'refs/heads/develop' && needs.changes.outputs.pgtileserv == 'true' }} | |
| runs-on: ubuntu-24.04 | |
| env: | |
| KUBE_CONFIG: ${{ secrets.KUBE_CONFIG }} | |
| PGTILESERV_NAMESPACE: pgtileserv | |
| environment: | |
| name: K8S pgtileserv | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Deploy pgtileserv to kubernetes | |
| uses: actions-hub/kubectl@v1.33.1 | |
| with: | |
| args: apply -f backends/k8s/pgtileserv/yaml/pgtileserv-deployment.yaml | |
| - name: Delete Secrets for pgtileserv | |
| uses: actions-hub/kubectl@v1.33.1 | |
| with: | |
| args: delete secret pgtileserv-secrets --ignore-not-found -n ${{ env.PGTILESERV_NAMESPACE }} | |
| - name: Create Secrets for pgtileserv | |
| uses: actions-hub/kubectl@v1.33.1 | |
| with: | |
| args: create secret generic pgtileserv-secrets --from-literal=DATABASE_URL=${{ secrets.DATABASE_URL }} -n ${{ env.PGTILESERV_NAMESPACE }} | |
| k8s_datapipeline_deploy: | |
| name: Deploy geohub-data-pipeline to Kubernetes | |
| needs: changes | |
| if: ${{ github.ref == 'refs/heads/develop' && needs.changes.outputs.datapipeline == 'true' }} | |
| runs-on: ubuntu-latest | |
| env: | |
| KUBE_CONFIG: ${{ secrets.KUBE_CONFIG }} | |
| DEPLOYMENT_NAMESPACE: data | |
| environment: | |
| name: K8S data-pipeline | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Delete Secrets | |
| uses: actions-hub/kubectl@v1.33.1 | |
| with: | |
| args: delete secret ingest-secrets --ignore-not-found -n ${{ env.DEPLOYMENT_NAMESPACE }} | |
| - name: Create Secrets | |
| uses: actions-hub/kubectl@v1.33.1 | |
| with: | |
| args: create secret generic ingest-secrets --from-literal=AZURE_STORAGE_CONNECTION_STRING=${{ secrets.AZURE_STORAGE_CONNECTION_STRING }} --from-literal=SERVICE_BUS_CONNECTION_STRING=${{ secrets.SERVICE_BUS_CONNECTION_STRING }} --from-literal=AZURE_WEBPUBSUB_CONNECTION_STRING=${{ secrets.AZURE_WEBPUBSUB_CONNECTION_STRING }} -n ${{ env.DEPLOYMENT_NAMESPACE }} | |
| - name: Deploy ingest to kubernetes | |
| uses: actions-hub/kubectl@v1.33.1 | |
| env: | |
| SERVICE_BUS_CONNECTION_STRING: ${{ secrets.SERVICE_BUS_CONNECTION_STRING }} | |
| with: | |
| args: apply -f backends/k8s/data-pipeline/yaml/ingest-environment.yaml | |
| k8s_cogserver_dev_deploy: | |
| name: Deploy cogserver-dev to Kubernetes | |
| needs: changes | |
| if: ${{ github.ref == 'refs/heads/develop' && needs.changes.outputs.cogserver-dev == 'true' }} | |
| runs-on: ubuntu-24.04 | |
| env: | |
| KUBE_CONFIG: ${{ secrets.KUBE_CONFIG }} | |
| environment: | |
| name: K8S cogserver-dev | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Deploy cogserver-dev to kubernetes | |
| uses: actions-hub/kubectl@v1.33.1 | |
| with: | |
| args: apply -f backends/k8s/cogserver/yaml/cogserver-dev-deployment.yaml | |
| k8s_cogserver_deploy: | |
| name: Deploy cogserver to Kubernetes | |
| needs: changes | |
| if: ${{ github.ref == 'refs/heads/main' && needs.changes.outputs.cogserver == 'true' }} | |
| runs-on: ubuntu-24.04 | |
| env: | |
| KUBE_CONFIG: ${{ secrets.KUBE_CONFIG }} | |
| environment: | |
| name: K8S cogserver | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Deploy cogserver to kubernetes | |
| uses: actions-hub/kubectl@v1.33.1 | |
| with: | |
| args: apply -f backends/k8s/cogserver/yaml/cogserver-deployment.yaml | |
| k8s_stacpipeline_deploy: | |
| name: Deploy geo-undpstac-pipeline to Kubernetes | |
| needs: changes | |
| if: ${{ github.ref == 'refs/heads/develop' && needs.changes.outputs.stacpipeline == 'true' }} | |
| runs-on: ubuntu-latest | |
| env: | |
| KUBE_CONFIG: ${{ secrets.KUBE_CONFIG }} | |
| DEPLOYMENT_NAMESPACE: stac | |
| AZURE_SERVICE_BUS_QUEUE_NAME: undp-stac-pipeline | |
| environment: | |
| name: K8S stac-pipeline | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Delete Secrets | |
| uses: actions-hub/kubectl@v1.33.1 | |
| with: | |
| args: delete secret stac-secrets --ignore-not-found -n ${{ env.DEPLOYMENT_NAMESPACE }} | |
| - name: Create Secrets | |
| uses: actions-hub/kubectl@v1.33.1 | |
| with: | |
| args: create secret generic stac-secrets --from-literal=AZURE_STORAGE_CONNECTION_STRING=${{ secrets.AZURE_STORAGE_CONNECTION_STRING }} --from-literal=AZURE_SERVICE_BUS_CONNECTION_STRING=${{ secrets.AZURE_SERVICE_BUS_CONNECTION_STRING }} --from-literal=AZURE_SERVICE_BUS_QUEUE_NAME=${{ env.AZURE_SERVICE_BUS_QUEUE_NAME }} --from-literal=EOG_USER=${{ secrets.EOG_USER }} --from-literal=EOG_PASSWORD=${{ secrets.EOG_PASSWORD }} -n ${{ env.DEPLOYMENT_NAMESPACE }} | |
| - name: Deploy ingest to kubernetes | |
| uses: actions-hub/kubectl@v1.33.1 | |
| env: | |
| AZURE_SERVICE_BUS_CONNECTION_STRING: ${{ secrets.AZURE_SERVICE_BUS_CONNECTION_STRING }} | |
| with: | |
| args: apply -f backends/k8s/stac-pipeline/yaml/deployment.yaml |