Skip to content

siosawa/GA_test

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ochacafe-github-actions

badge badge

Oracle Cloud Hangout Cafe Season7 #3 Get Started GitHub Actions!!

Directory Configuration

.
├── .github
│   └── workflows
│       ├── oke_demo_deploy.yaml # OKE Deploy Workflow for GitHub Hosted Runner
│       ├── oke_demo_deploy_arc.yaml # OKE Deploy Workflow for Actions Runner Controller
│       ├── oke_demo_workflow.yaml # GitHub Actions Workflow Demo Workflow for GitHub Hosted Runner
│       ├── oke_demo_workflow_arc.yaml  # GitHub Actions Workflow Demo Workflow for Actions Runner Controller
│       └── simple_demo.yaml # Simple Workflow Demo Workflow
├── README.md
├── go-app # Simple Workflow Demo App
├── img
├── k8s
│   ├── arc.yaml  # Actions Runner Controller Manifest
│   └── demo.yaml  # GitHub Actions Workflow Demo Manifest
└── oke-app   # GitHub Actions Workflow Demo App

GitHub Actions利用手順

レポジトリのfork

このレポジトリをforkしてください。

img/01.png

Secretの設定

サンプルアプリケーションをOracle Container Engine for Kubernetes(以下、OKE)にデプロイするための情報をGitHub Secretとして登録します。

GitHub上部のSettingsをクリックします。

img/02.png

Secrets and variablesactionsをクリックします。

img/03.png

New repository secretをクリックします。

img/04.png

以下のSecretを作成します。

項目 設定内容
OCI_CLI_FINGERPRINT チュートリアル内で取得できるAPIキーのフィンガープリント
OCI_CLI_KEY_CONTENT チュートリアル内で取得できるAPIキーの秘密鍵
OCI_CLI_REGION チュートリアル内で取得できるAPIキーの秘密鍵
OCI_CLI_TENANCY チュートリアル内で取得できるテナンシOCID
OCI_CLI_USER チュートリアル内で取得できるユーザのOCID
OKE_CLUSTER_OCID チュートリアルで取得できるクラスタOCID

これでSecretの作成は完了です。

MySQL Database Serviceのプロビジョニング

以降のサンプルアプリケーションで利用するMySQL Database Serviceをプロビジョニングします。
プロビジョニングはチュートリアルをご確認ください。
なお、プロビジョニングに利用するVCNはOKEと同一のVCNを利用してください。

プロビジョニング時に指定したユーザ名パスワードIPアドレスをメモしておきます。

以下のコマンドでMySQL Database Serviceに接続するためのKubernetes Secretをdefault namespaceに作成します。

kubectl create secret generic db-secret --from-literal=username=<ユーザ名> --from-literal=password=<パスワード> --from-literal=host=<IPアドレス>

これでMySQL Database Serviceのプロビジョニングは完了です。

動作確認

動作確認をします。

サンプルデモは2種類あるので、それぞれ説明します。

Simple Workflow Demo

Simple Workflow Demo用のサンプルアプリケーションは、go-app配下に存在します。 このアプリケーションはHello Worldを標準出力するシンプルなソースコードです。

Simple Workflow Demoは以下の通り、mainレポジトリにPushすると動作する設定になっています。

name: Simple Demo

on:
  push:
    paths:
      - "go-app/**"
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Start message
        run: echo "Welcome to GitHub Actions"
      - uses: actions/checkout@v3
      - name: Setup Go version
        uses: actions/setup-go@v4
        with:
          go-version: "1.19.1"
      - run: go run go-app/hello-world.go
      - name: Finish message
        run: echo "Finished running the demo"

Workflowの中身は、以下の通りです。

  1. 開始メッセージを出力
  2. レポジトリをチェックアウト
  3. Go v1.19.1で実行
  4. 終了メッセージを出力

Goファイルの中身は以下のようになっています。

package main

import "fmt"

func main() {
	fmt.Printf("Hello World \n")
}

例えば、以下のように変更してPushします。

func main() {
	fmt.Printf("Hello OCHa \n")
}

Pushすると、GitHub Actionsが動作します。

img/05.png

結果を見てみると以下のようになります。

img/06.png

これでSimple Workflow Demoのデモは完了です。

GitHub Actions Workflow Demo

GitHub Actions Workflow Demo用のサンプルアプリケーションは、oke-app配下に存在します。
このアプリケーションはフロントエンドはNext.jsアプリ、バックエンドはGoアプリです。

このWorkflowは以下の機能を利用したものになります。

  • マトリクス戦略
  • Cache
  • Reusable Workflow
  • サービスコンテナ
  • GitHub Packages
  • GitHub Secrets

このWorkflowの流れは大きく以下の通りです。

img/07.png

4つのジョブから構成されています。

ジョブ1:マトリクス戦略により、Goの3バージョンで並列に実行、MySQLのサービスコンテナを利用してテストを実施
ジョブ2,ジョブ3: 並列にGoアプリとNext.jsアプリのコンテナイメージをビルドし、GitHub Packagesの一部であるGitHub Container RegistryにPush、ビルドの際にはCacheを利用してビルド時間を短縮
ジョブ4: Reusable Workflowとして実行、GitHub Secretsに格納された情報をもとにOracle Container Engine for Kubernetesにアプリをデプロイ

GitHub Actions Workflow Demooke-app配下のいずれかのファイルの更新によりトリガーされます。

まずはデモアプリケーション用のNamespaceを作成しておきます。

kubectl create ns demo

ここでは、oke-app/backend-app/db/db.goに定義されたテーブル情報を更新してみましょう。
このテーブル情報はアプリ起動時にMySQLに対して書き込みされます。

現状は以下のようになっています。

		{
			Name:       "Kubernetes超入門",
			Date:       time.Date(2023, 6, 7, 19, 00, 00, 000000, time.UTC).Format("20060102150405"),
			Topics:     "Kubernetes",
			Presenters: "Yutaka Ichikawa",
		},
		{
			Name:       "IaCのベストプラクティス",
			Date:       time.Date(2023, 7, 5, 19, 00, 00, 000000, time.UTC).Format("20060102150405"),
			Topics:     "Terraform, Pulumi",
			Presenters: "Shuhei Kawamura",
		},
		{
			Name:       "GitHub Actionsを使いこなせ!",
			Date:       time.Date(2023, 8, 9, 19, 00, 00, 000000, time.UTC).Format("20060102150405"),
			Topics:     "GitHub Actions",
			Presenters: "Takuya Niita",
		},
		{
			Name:       "セキュアなWeb APIの作り方",
			Date:       time.Date(2023, 9, 6, 19, 00, 00, 000000, time.UTC).Format("20060102150405"),
		    Topics:     "Keycloak, cert-manager",
			Presenters: "Shuhei Kawamura",
		},
		{
			Name:       "Cluster API - K8sクラスタ管理の新スタイル",
			Date:       "TBD",
			Topics:     "Cluster API, API Provider for OCI",
			Presenters: "Takuya Niita",
		},
		{
			Name:       "次はこれでしょ!eBPF",
			Date:       "TBD",
			Topics:     "eBPF, CNI, Cilium",
			Presenters: "Yutaka Ichikawa",
		},

セキュアなWeb APIの作り方は日程が2023/9/6と決まっているので、以下のように更新します。

		{
			Name:       "セキュアなWeb APIの作り方",
			Date:       time.Date(2023, 9, 6, 19, 00, 00, 000000, time.UTC).Format("20060102150405"),
			Topics:     "Keycloak, cert-manager",
			Presenters: "Shuhei Kawamura",
		},

また、今回はGitHub Actions内でビルドしたデモアプリケーションのコンテナイメージをGHCR(GitHub Container Registry)に対してPushしているので、 Kubernetes Manifestのイメージパスを書き換えます。
Kubernetes Manifestはk8s/demo.yamlに存在します。

kind: Service
apiVersion: v1
metadata:
  name: github-actions-demo-lb
spec:
  selector:
    app: frontend
  type: LoadBalancer
  ports:
    - name: http
      port: 80
      targetPort: 3000
---
kind: Service
apiVersion: v1
metadata:
  name: github-actions-demo-backend
spec:
  selector:
    app: backend
  type: ClusterIP
  ports:
    - name: http
      port: 8080
      targetPort: 8080
---
kind: Deployment
apiVersion: apps/v1
metadata:
  name: github-actions-demo-frontend
spec:
  replicas: 1
  selector:
    matchLabels:
      app: frontend
  template:
    metadata:
      labels:
        app: frontend
    spec:
      containers:
        - name: github-actions-demo-frontend
          image: ghcr.io/oracle-japan/ochacafe-github-actions/oke-app-nextjs:latest
          ports:
            - containerPort: 3000
          resources:
            requests:
              cpu: 200m
              memory: 100Mi
          env:
            - name: API_URL
              value: github-actions-demo-backend:8080
            - name: NEXT_PUBLIC_API_URL
              value: github-actions-demo-backend:8080
      imagePullSecrets:
        - name: regcred
---
kind: Deployment
apiVersion: apps/v1
metadata:
  name: github-actions-demo-backend
spec:
  replicas: 1
  selector:
    matchLabels:
      app: backend
  template:
    metadata:
      labels:
        app: backend
    spec:
      containers:
        - name: github-actions-demo-backend
          image: ghcr.io/oracle-japan/ochacafe-github-actions/oke-app-golang:latest
          ports:
            - containerPort: 8080
          resources:
            requests:
              cpu: 200m
              memory: 100Mi
          env:
            - name: DB_USER
              valueFrom:
                secretKeyRef:
                  name: db-secret
                  key: username
            - name: DB_PASSWORD
              valueFrom:
                secretKeyRef:
                  name: db-secret
                  key: password
            - name: DB_HOST
              valueFrom:
                secretKeyRef:
                  name: db-secret
                  key: host
            - name: DB_NAME
              value: mydb
      imagePullSecrets:
        - name: regcred

このManifest内の

          image: ghcr.io/oracle-japan/ochacafe-github-actions/oke-app-nextjs:latest
          image: ghcr.io/oracle-japan/ochacafe-github-actions/oke-app-golang:latest

上記2つのイメージパスをforkしたレポジトリのオーナーで更新します。
例えば、tniitaというオーナーのレポジトリにforkした場合は、それぞれ以下のようになります。

          image: ghcr.io/tniita/ochacafe-github-actions/oke-app-nextjs:latest
          image: ghcr.io/tniita/ochacafe-github-actions/oke-app-golang:latest

これらのファイルをPushすると、GitHub Actionsが動作します。

img/08.png

デプロイされると以下のようなアプリケーションがOKEにデプロイされます。

img/09.png

ビルドされたコンテナはGitHub PackagesにPushされているので、以下で確認できます。  

img/010.png

コンテナイメージなどのCacheについては以下から確認できます。

img/011.png

これでGitHub Actions Workflow Demoのデモは完了です。

[option]Actions Runnner Controller利用手順

ここでは、Actions Runnner Controllerを利用する手順を説明します。

Warning この手順を実施する場合はセキュリティ確保のため、必ずプライベートレポジトリで実施してください。

Actions Runnner Controllerを利用する場合は、事前準備としてこちらを実施してください。

k8s/arc.yamlにActions Runner ControllerのManifestがあります。

apiVersion: actions.summerwind.dev/v1alpha1
kind: RunnerDeployment
metadata:
  name: runner-demo-oke
spec:
  template:
    spec:
      repository: <fork先のユーザ名>/ochacafe-github-actions
      labels:
        - runner-demo-oke
      resources:
        limits:
          cpu: "1.0"
          memory: "4Gi"
        requests:
          cpu: "1.0"
          memory: "4Gi"

repository: <fork先のユーザ名>/ochacafe-github-actionsの部分をforkしたご自身のレポジトリ名に合わせてください。

Manifestをデプロイします。

kubectl apply -f k8s/arc.yaml

デプロイすると以下のようにPodが作成されます。

$ kubectl get pods -n actions-runner-system cert-manager default
NAMESPACE               NAME                                            READY   STATUS    RESTARTS        AGE
actions-runner-system   controller-manager-5f468ff884-hl6pp             2/2     Running   2 (2d14h ago)   10d
cert-manager            cert-manager-bfcd95fbc-h9n77                    1/1     Running   0               10d
cert-manager            cert-manager-cainjector-6c65c9f988-d49q2        1/1     Running   0               10d
cert-manager            cert-manager-webhook-78b75fb78f-jtclh           1/1     Running   0               10d
default                 runner-demo-oke-x8hvx-4nttd                     2/2     Running   0               10d
default                 runner-demo-oke-x8hvx-fjxsz                     2/2     Running   0               10d
default                 runner-demo-oke-x8hvx-q6s7z                     2/2     Running   0               10d

runner-demo-oke-xxxがそれぞれGitHub Actionsのランナーの役割を果たすPodです。

これはGitHubのUIからでも確認できます。

img/012.png

上記でデプロイしたManifestでは、runnner-demo-okeというラベルを付与しています。

今回は、手動でOKE GitHub Actions Workflow ARC Demoを実行してください。

img/013.png

JobがOKEのPodで実行されていることが確認できます。

img/014.png

img/015.png

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •