Deployment dengan S2I Process OpenShift

2021-04-02 1551 words 8 minutes

Contents

S2I atau Source to Image adalah sebuah tool untuk mempermudah membangun container images dari source code. Tool ini mengambil source code aplikasi dari repositori Git, melakukan injeksi source code ke dalam base container berdasarkan bahasa pemrograman dan framework tertentu, kemudian memproduksi sebuah container image baru, lalu container image tersebut akan dipakai untuk menjalankan aplikasi yang telah dirakit.

/deployment-dengan-s2i-process-openshift/openshift-dc-and-bc.png — S2I pada OpenShift

Image Stream

OpenShift mendeploy aplikasi versi baru ke dalam pod secara cepat. Base Image (S2I buider image) dibutuhkan untuk membuat aplikasi dengan update terbaru, jika ada perubahan pada source code. Ketika komponen source code aplikasi mengalami perubahan, OpenShift akan menciptakan container image baru. Pod yang telah dibuat dengan container image lama akan digantikan dengan pod yang menggunakan image baru.

Resource Image Stream merupakan konfigurasi yang menamai container image secara spesifik yang berkaitan dengan tag image stream. OpenShift membangun aplikasi berdasarkan image stream. OpenShift installer telah menyediakan beberapa image stream secara default sejak awal. Untuk menemukan image stream yang tersedia, gunakan perintah oc get seperti berikut.

1
2
3
4
5
6
7
8
9
$ oc get is -n openshift

NAME           IMAGE REPOSITORY                      TAGS
dotnet         ...svc:5000/openshift/dotnet          2.0,2.1,latest
nodejs         ...svc:5000/openshift/nodejs          0.10,10,11,4,6,8,latest
perl           ...svc:5000/openshift/perl            5.16,5.20,5.24,5.26,latest
php            ...svc:5000/openshift/php             5.5,5.6,7.0,7.1,latest
python         ...svc:5000/openshift/python          2.7,3.3,3.4,3.5,3.6,latest
ruby           ...svc:5000/openshift/ruby            2.0,2.2,2.3,2.4,2.5,latest

OpenShift juga mendeteksi jika image stream berubah dan akan melakukan reaksi berdasarkan perubahan tersebut. Jika sebuah security issue muncul, misalnya (CVE) pada image bernama nodejs-010-rhel7, maka OpenShift akan melakukan update secara otomatis.

Build S2I

Membangun sebuah aplikasi menggunakan S2I dapat dilakukan melalui OpenShift CLI maupun OpenShift Web Console. Dalam artikel ini, saya ingin melakukannya melalui CLI.

/deployment-dengan-s2i-process-openshift/s2i-process.png — S2I Process

Via CLI

Untuk membuat application di dalam project dengan proses S2I kita memakai perintah oc new-app sseperti berikut.

1
oc new-app --as-deployment-config php~http://my.git.server.com/my-app --name=myapp

Argumen php di atas dipakai untuk mendefinisikan image stream mana yang akan digunakan, diikuti oleh karakter ~. Lalu diteruskan dengan lokasi repositori Git my.git.server.com/my-app. Selain menggunakan karakter ~ kita dapat menuliskannya menggunakan opsi -i seperti berikut.

1
oc new-app --as-deployment-config -i php http://services.lab.example.com/app --name=myapp

Repositori Lokal

Jika kita tidak mendefinisikan image stream, maka OpenShift akan mencoba untuk melakukan identifikasi otomatis terhadap source code guna menemukan image stream yang tepat. Command oc new-app juga dapat dilakukan ketika kita menggunakan repositori Git lokal. Misalnya jika kita sudah berapa di direktori repositori Git lokal, maka dapat kita jalankan perintah berikut.

1
oc new-app --as-deployment-config .

Perhatian

Jika menggunakan repositori Git lokal, maka repositori tersebut harus memiliki konfigurasi remote origin yang mengarah ke sebuah URL. Dan URL tersebut harus dapat diakses dari klaster OpenShift.

Subdirektori

Kita juga dapat menjalankan aplikasi menggunakan subdirektori pada repositori Git seperti berikut.

1
2
3
oc new-app --as-deployment-config \
  https://github.com/openshift/sti-ruby.git \
  --context-dir=2.0/test/puma-test-app

Branch

Dan tentu saja S2I dapat kita lakukan pada branch atau cabang tertentu dari repositori Git, seperti berikut.

1
2
oc new-app --as-deployment-config \
  https://github.com/openshift/ruby-hello-world.git#beta4

Deteksi Otomatis

Seperti yang sebelumnya saya tulis di atas, jika kita tidak mendefinisikan image stream maka OpenShift akan secara otomatis melakukan deteksi secara otomatis. Deteksi tersebut dilakukan berdasarkan beberapa file yang terdapat dalam repositori.

Bahasa Pemrograman	File
Ruby	Rakefile Gemfile, config.ru
Java EE	pom.xml
Node.js	app.json package.json
PHP	index.php composer.json
Python	requirements.txt config.py
Perl	index.pl cpanfile

Setelah bahasa pemrograman terdeteksi, OpenShift akan mencari tag image stream yang mendukung, atau yang sesuai dengan nama dari bahasa pemrograman tersebut.

Generate Resource Definition File

Untuk membuat sebuah file definisi resource (jika dibutuhkan) kita dapat menggunakan parameter -o kemudian diikuti dengan format yang diinginkan, misalnya yaml atau json.

1
2
3
oc -o json new-app --as-deployment-config \
 php~http://services.lab.example.com/app \
 --name=myapp > s2i.json

Dan kita akan mendapatkan file bernama s2i.json berisi seperti berikut.

Image Stream Definition

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
...
{
    "kind": "ImageStream",
    "apiVersion": "image.openshift.io/v1",
    "metadata": {
        "name": "myapp",
        "creationTimestamp": null
        "labels": {
                    "app": "myapp"
                },
                "annotations": {
                    "openshift.io/generated-by": "OpenShiftNewApp"
                }
    },
    "spec": {
        "lookupPolicy": {
            "local": false
        }
    },
    "status": {
        "dockerImageRepository": ""
    }
},
...

Dapat kita lihat bahwa terdapat pendefinisian resource "kind": "ImageStream" dan resource tersebut akan memakai nama yang sama dengan parameter --name.

Build Configuration Definition

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
...
{
    "kind": "BuildConfig",
    "apiVersion": "build.openshift.io/v1",
    "metadata": {
        "name": "myapp",
        "creationTimestamp": null,
        "labels": {
            "app": "myapp"
        },
        "annotations": {
            "openshift.io/generated-by": "OpenShiftNewApp"
        }
    },
    "spec": {
        "triggers": [
            {
                "type": "GitHub",
                "github": {
                    "secret": "S5_4BZpPabM6KrIuPBvI"
                }
            },
            {
                "type": "Generic",
                "generic": {
                    "secret": "3q8K8JNDoRzhjoz1KgMz"
                }
            },
            {
                "type": "ConfigChange"
            },
            {
                "type": "ImageChange",
                "imageChange": {}
            }
        ],
        "source": {
            "type": "Git",
            "git": {
                "uri": "http://services.lab.example.com/app"
            }
        },
        "strategy": {
            "type": "Source",
            "sourceStrategy": {
                "from": {
                    "kind": "ImageStreamTag",
                    "namespace": "openshift",
                    "name": "php:7.3"
                }
            }
        },
        "output": {
            "to": {
                "kind": "ImageStreamTag",
                "name": "myapp:latest"
            }
        },
        "resources": {},
        "postCommit": {},
        "nodeSelector": null
    },
    "status": {
        "lastVersion": 0
    }
},
...

Di dalam file tersebut kita juga akan mendapati resource "kind": "BuildConfig". Build config atau bc bertanggung jawab untuk mendefinisikan parameter input dan trigger yang akan dieksekusi untuk merubah source code menjadi container image.

Deployment Configuration Definition

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
...
{
    "kind": "DeploymentConfig",
    "apiVersion": "apps.openshift.io/v1",
    "metadata": {
        "name": "myapp",
        "creationTimestamp": null,
        "labels": {
            "app": "myapp"
        },
        "annotations": {
            "openshift.io/generated-by": "OpenShiftNewApp"
        }
    },
    "spec": {
        "strategy": {
            "resources": {}
        },
        "triggers": [
            {
                "type": "ConfigChange"
            },
            {
                "type": "ImageChange",
                "imageChangeParams": {
                    "automatic": true,
                    "containerNames": [
                        "myapp"
                    ],
                    "from": {
                        "kind": "ImageStreamTag",
                        "name": "myapp:latest"
                    }
                }
            }
        ],
        "replicas": 1,
        "test": false,
        "selector": {
            "app": "myapp",
            "deploymentconfig": "myapp"
        },
        "template": {
            "metadata": {
                "creationTimestamp": null,
                "labels": {
                    "app": "myapp",
                    "deploymentconfig": "myapp"
                },
                "annotations": {
                    "openshift.io/generated-by": "OpenShiftNewApp"
                }
            },
            "spec": {
                "containers": [
                    {
                        "name": "myapp",
                        "image": "myapp:latest",
                        "ports": [
                            {
                                "containerPort": 8080,
                                "protocol": "TCP"
                            },
                            {
                                "containerPort": 8443,
                                "protocol": "TCP"
                            }
                        ],
                        "resources": {}
                    }
                ]
            }
        }
    },
    "status": {
        "latestVersion": 0,
        "observedGeneration": 0,
        "replicas": 0,
        "updatedReplicas": 0,
        "availableReplicas": 0,
        "unavailableReplicas": 0
    }
},
...

Resource selanjutnya adalah Deployment Configuration atau dc yang bertanggung jawab untuk melakukan preferensi proses deployment di OpenShift. Di dalamnya dapat berisi parameter dan trigger yang diperlukan untuk membuat container, dan diterjemahkan menjadi replication controller. Beberapa manfaat yang disediakan oleh objek DeploymentConfig adalah sebagai berikut.

Dapat dilakukannya kustomisasi strategi terhadap deployment.
Dapat digunakan untuk Rollback ke deployment sebelumnya.
Dapat dipakai untuk scaling replikasi secara manual.

Service Definition

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
...
{
    "kind": "Service",
    "apiVersion": "v1",
    "metadata": {
        "name": "myapp",
        "creationTimestamp": null,
        "labels": {
            "app": "myapp"
        },
        "annotations": {
            "openshift.io/generated-by": "OpenShiftNewApp"
        }
    },
    "spec": {
        "ports": [
            {
                "name": "8080-tcp",
                "protocol": "TCP",
                "port": 8080,
                "targetPort": 8080
            },
            {
                "name": "8443-tcp",
                "protocol": "TCP",
                "port": 8443,
                "targetPort": 8443
            }
        ],
        "selector": {
            "app": "myapp",
            "deploymentconfig": "myapp"
        }
    },
    "status": {
        "loadBalancer": {}
    }
}

Terakhir kita akan mendapati resource Service atau svc yang berfungsi untuk menghubungkan setiap container yang ada di dalam klaster.

Perhatian

Command oc new-app secara default tidak akan membuat resource route. Route berfungsi untuk melakukan ingress traffic dari luar klaster supaya dapat mengakses aplikasi. Jika kita menggunakan OpenShift Web Console, maka route akan dibuat secara otomatis menggunakan template yang telah tersedia.

Memeriksa Deployment

Setelah membuat application seperti di atas, proses build akan dijalankan. Gunakan command oc get builds untuk melihat daftar build aplikasi.

1
2
3
$ oc get builds
NAME               TYPE     FROM          STATUS    STARTED          DURATION
php-helloworld-1   Source   Git@9e17db8   Running   13 seconds ago

Kita dapat melihat log dari build menggunakan perintah berikut.

1
oc logs build/myapp-1

Perhatian

Jika status build belum menampilkan Running, atau OpenShift belum mendeploy pod s2i-build maka output berupa error akan muncul dari log.

Trigger Build

Kita dapat me-trigger build baru berdasarkan bc (Build Config) yang tersedia dengan perintah berikut.

Melihat BuildConfig

1
2
3
$ oc get buildconfig
NAME           TYPE      FROM      LATEST
myapp          Source    Git       1

Menjalankan Build

1
2
$ oc start-build myapp
build "myapp-2" started

Kesimpulan

/deployment-dengan-s2i-process-openshift/summary.png — Alur S2I

Pod BuildConfig dipakai untuk membuat image dalam OpenShift dan melakukan push ke container registry internal. Setiap konten atau source code yang mengalami perubahan biasanya membutuhkan build baru untuk menjamin supaya image terupdate. Pod DeploymentConfig digunakan untuk mendeploy pod dalam OpenShift. Hasilnya adalah deployment pod dengan image dari container registry internal. Setiap pod yang sebelumnya telah ada akan di-destroy, tergantung dari bagaimana resource DeploymentConfig dibuat. BuildConfig dan DeploymentConfig tidak berinteraksi secara langsung. BuildConfig membuat atau mengupdate container image, sedangkan DeploymentConfig akan bereaksi kepada image baru tersebut dan kemudian membuat pod baru darinya.

Contents

Deployment dengan S2I Process OpenShift

Image Stream

Build S2I

Via CLI

Repositori Lokal

Subdirektori

Branch

Deteksi Otomatis

Generate Resource Definition File

Image Stream Definition

Build Configuration Definition

Deployment Configuration Definition

Service Definition

Memeriksa Deployment

Trigger Build

Melihat BuildConfig

Menjalankan Build

Kesimpulan

Referensi