Gitlab CI/CD 之 when

-

前言

上次教到如何使用 environment 去自動設置我們環境那些，今天我們要教 CI/CD 中的 when，通常在自動化佈署上線流程，並不會一路像前幾次一樣，先佈署到測試機，再佈署 demo 機，最後佈署到正式機，我們在佈署正式機的時候，通常會做一個防呆，比如說做成一個指令集，或者是按鈕等等，以避免出嚴重大錯

when 作用

when 是可以幫助我們在自動化佈署時，可以定義那些工作，是可以不要這麼早，就有所動作，等到我們比較確定的時候，比如說我們按下按鈕，這個工作才會開始運作，所以也可以讓我們做個半自動化，而不是全自動化

when 定義

when 這個 script 在 Gitlab CI/CD 底下提供了一些語法，以下是在 Gitlab 官網所到的，在文章的最地下，會提供相關網址

在我個人比較常使用的是 manual 這個語法，他可以在工作前，提供一個按鈕，讓我們手動按下去，才執行工作，有如以下範例

image: mcr.microsoft.com/dotnet/sdk:6.0


stages:

    - deploy


deploy:

    stage: deploy

    when: manual

    script:

         - echo 'deploy service'

練習時間

接下來我們開始使用這個 when 語法，在我們 deploy-to-production 這個工作加上 when 這個語法，讓我們正式機不要這麼快馬上上線

image: mcr.microsoft.com/dotnet/sdk:6.0


stages:

    - deploy


.deploy:

    tags:

        - shell

    variables:

        SERVER_NAME: ""

        SERVER_PRIVATE_KEY: ""

        SERVER_USER_NAME: ""

        SERVER_URL: ""

        SERVER_PORT: ""

        SERVER_ENV: ""

    before_script:

        - eval $(ssh-agent -s)

        - ssh-add <(echo "$SERVER_PRIVATE_KEY")

        - echo $DOCKER_REGISTRY_PASSWORD | docker login -u $DOCKER_REGISTRY_USERNAME --password-stdin

    script:

        - ssh -o StrictHostKeyChecking=no $SERVER_USER_NAME@$SERVER_URL "

            mkdir -p ~/DotNetCoreWebApiCiAndCdCourse"

        - scp -o StrictHostKeyChecking=no ./docker-compose.yml $SERVER_USER_NAME@$SERVER_URL:~/DotNetCoreWebApiCiAndCdCourse

        - ssh -o StrictHostKeyChecking=no $SERVER_USER_NAME@$SERVER_URL "

            export COMPOSE_PROJECT_NAME=$SERVER_ENV

            export SERVER_ENV=$SERVER_ENV

            export SERVER_PORT=$SERVER_PORT


            cd ~/DotNetCoreWebApiCiAndCdCourse &&

            docker compose up --build -d"

    environment:

        name: $SERVER_NAME

        url: http://$SERVER_URL:$SERVER_PORT


deploy-to-development:

    stage: deploy

    tags:

        - shell

    variables:

        SERVER_NAME: DotNetCoreWebApiCiAndCdCourse development environment

        SERVER_PRIVATE_KEY: $DEV_SERVER_PRIVATE_KEY

        SERVER_USER_NAME: $DEV_SERVER_USER_NAME

        SERVER_URL: $DEV_SERVER_URL

        SERVER_PORT: 8080

        SERVER_ENV: development

    extends: .deploy

    

deploy-to-staging:

    stage: deploy

    tags:

        - shell

    variables:

        SERVER_NAME: DotNetCoreWebApiCiAndCdCourse staging environment

        SERVER_PRIVATE_KEY: $DEV_SERVER_PRIVATE_KEY

        SERVER_USER_NAME: $DEV_SERVER_USER_NAME

        SERVER_URL: $DEV_SERVER_URL

        SERVER_PORT: 8081

        SERVER_ENV: staging

    extends: .deploy

    needs:

        - deploy-to-development


deploy-to-production:

    stage: deploy

    tags:

        - shell

    variables:

        SERVER_NAME: DotNetCoreWebApiCiAndCdCourse production environment

        SERVER_PRIVATE_KEY: $DEV_SERVER_PRIVATE_KEY

        SERVER_USER_NAME: $DEV_SERVER_USER_NAME

        SERVER_URL: $DEV_SERVER_URL

        SERVER_PORT: 80

        SERVER_ENV: production

    extends: .deploy

    when: manual

    needs:

        - deploy-to-staging

再來我們將我們的這個 CI/CD 腳本，上傳到 gitlab 讓我們觀察的運作，可以看到在前面 deploy-to-develop 及 deploy-to-staging 這兩個工作都已經成功佈署上去，而在 deploy-to-production 這個工作產生一個按鈕，等待我們按下去

再來我們將這顆按鈕按下去，就可以看到 deploy-to-production 這個工作就會開始運作了

相關文獻

留言

發佈留言

此網誌的熱門文章

Gitlab CI/CD 之 Group Runner

-
圖片
前言 上次我們教到 GitLab CI/CD 的 artifacts，今天我們要來講一個叫做 Group Runner，什麼是 Group Runner 我們今天待會會講道。 Gitlab Runner 類型 我們可以看到官網文件，Gitlab 提供了三種 Runner 類型，第一種叫 Shared runners，第二種叫 Group runners，第三種叫  Project runners Shared runners: 也就是我們之前看到 Gitlab 提供的那些 Runner Project runners: 也就是這個 Runner 設定只能在某一個專案跑 Group runners: 也就是說我會開一個群組，如果有些專案是在這群組的，可以共用這些群組上的 Runner 創建群組 接下來我們來創建一個群組，將我們的專案加入進群組，並且創建一個 Group runner，讓我們的專案可以使用群組上的 Runner，首先先點回去到 Gitlab 首頁->點擊 Groups->然後再點擊 New group 接下來在點擊 Create group 進去 接下來取名好群組名稱後，按下 Create group 按鈕，就可以成功建立群組 建立 Group Runner 接下來我們進到 develop 這個目錄裡面有個 Build->Runner 的最右手邊這裡就有我們的註冊 Group runner 之 token 接下來我們來建立 Group Runner，建立方法和之前建立 Project runners 很像再次教大家使用 gitlab-runner，首先先輸入以下指令 gitlab-runner register 在來這裡輸入我們要註冊的 Gitlab 網址 Runtime platform                                    arch=amd64 os=linux pid=96 revision=853330f9 version=16.5.0 Running in system-m
閱讀更多

Docker 之如何安裝 Docker 容器

-
圖片
前言 上次我們講到 Docker 的功用與好處，今天我們要在講解，如何安裝 Docker 這個容器，讓我們在之後的教學應用更好的實作與練習，現在讓我們開始吧 Docker Engine 與 Docker Desktop 首先在講解怎麼安裝 Docker 時，我們先講解 Docker Engine 跟 Docker Desktop 有甚麼不一樣，Docker Engine 是 Docker 最核心的部分，只要在電腦安裝了這個引擎，就可以馬上體驗 Docker，但是由於在操作 Docker 時，幾乎是命令介面，所以 Docker 後來有出 Docker Desktop，提供 UI 介面，盡可能貼近使用者操作，不過還是有很多事情是不能透過 Docker Desktop 去操作的 Docker 安裝環境選擇 如果你的電腦是一般練習的電腦，例如: 桌機、筆電，且作業系統是桌面型作業系統，那就可安裝 Docker Desktop，即可幫助你直接安裝好 Docker Engine，有完善的 UI 介面，如果你想自己灌一台伺服器等級的虛擬機，例如: 安裝 Ubuntu Server，那即可安裝好 Docker Engine 就可以體驗 Docker，不建議在虛擬機上安裝例如像 Ubuntu Desktop，裡面又安裝 Docker Desktop ，因為可能會有資源不夠的問題，現在如何安裝 Docker Engine 及 Docker Desktop 安裝 Docker Desktop 在這裡我們已 Windows 為範例，在我的文章最下面提供 Docker 官網下載網站，如果你的作業系統是 Windows 作業系統，就下載 Windows 版本 Docker Desktop，並依照安裝指示操作，即可完成安裝 以下是安裝玩後的 Docker Desktop 樣子，即可開始體驗 Docker 安裝 Docker Engine 如果你的作業系統是屬於伺服器等級的作業系統那只要安裝 Docker Engine 就好，在文章最下方會提供 Docker 官網安裝 Docker Engine 文獻，而下圖是以 Ubuntu 為例子的文獻，按照官網說明指令輸入，相信不會太困難
閱讀更多

Docker 之初體驗

-
圖片
前言 大家好在先前我們講了什麼是 Docker，Docker 好處有什麼以及怎麼安裝 Docker，今天我們要來開始初體驗 Docker 容器，使用後您會發現 Docker 非常的方便快速 Docker Hub 介紹 首先在開始學怎麼抓取 Docker Image 之前，我們要先來介紹 Docker Hub 這個平台，這是 Docker 為我們提供的一個雲端平台，他是可以讓我們存放 Docker Image 的這麼一個服務，可以透過他抓取我們想要的 Docker Image，也可以將我們所做的 Docker Image 存放到這個平台 查看 Nginx Image 接下來我們開始來準備抓取 Docker Image 工作準備，首先先在搜尋輸入 Nginx 查詢 Image，可以看到第一個就是了，請點進去 確認 Docker Image 版號 點進去 Nginx 裡面的頁面後，這裡會有一些關於這個 Image 的資訊，我們點擊如下圖，按下 Tags，並搜尋 alpine 的版本 往下捲動，我們要去抓如下圖 alpine 的版本 抓取 Nginx Docker Image 與佈署 確認好本版本後，我們開始抓取 Image 並佈署，輸入以下指令抓取 Image docker pull nginx:alpine 抓取完 Image 後，開始試著佈署 Nginx，輸入以下指令，即可開始佈署 docker run -d -p 80:80 nginx:alpine 在這時候打開瀏覽器，可以看到我們 Nginx 啟動成功 補充 為何我們抓取 Image 時，要特別抓 alpine 版本 ? 因為 alpine 是所以 linux 當中最小的系統，抓取速度快
閱讀更多