Serverless App Engine:saectl ツールのクイックスタート

名前空間の作成

1. namespace.yaml という名前のファイルを作成します。次のサンプルコードは、名前空間の構成を含むファイルの内容を示しています。

   apiVersion: v1
   kind: Namespace
   metadata:
     annotations:
       sae.aliyun.com/vpc-id: ${vpc-id} # ${vpc-id} を、名前空間に関連付ける VPC の ID に置き換えます。フォーマットは vpc-xxxxxxxxxxxxxxxxxxxxx です。
     name: ${namespace} # ${namespace} を名前空間名に置き換えます。
   spec: {}

2. namespace.yaml ファイルがあるディレクトリで、次のコマンドを実行して名前空間を作成します。

   saectl apply -f namespace.yaml

名前空間の表示

次のコマンドを実行して、指定したアプリケーションのデプロイリージョンに存在する名前空間を表示します。

saectl get ns

出力例は次のとおりです。

NAME        STATUS   REGION
default     Active   cn-beijing
testns      Active   cn-beijing

次の表に、各フィールドの説明を示します。

名前空間の削除

次のコマンドを実行して、指定した名前空間を削除します。

saectl delete ns ${namespace}
# ${namespace} は名前空間の名前です。

アプリケーションの作成

1. deployment.yaml という名前のファイルを作成します。次のサンプルコードは、アプリケーションの構成を含むファイルの内容を示しています。

   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: ${deployment-name} # ${deployment-name} をアプリケーション名に置き換えます。
   spec:
     replicas: 2 # アプリケーションインスタンスの数。
     selector:
       matchLabels:
         sae.aliyun.com/app-name: ${deployment-name} # ${deployment-name} をアプリケーション名に置き換えます。
     template:
       metadata:
         labels:
           sae.aliyun.com/app-name: ${deployment-name} # ${deployment-name} をアプリケーション名に置き換えます。
       spec:
         containers:
         - name: main # 競合を避けるためにコンテナー名を main に設定します。
           image: registry.openanolis.cn/openanolis/nginx:1.14.1-8.6 # この例では Nginx イメージを使用します。

2. deployment.yaml ファイルがあるディレクトリで、次のコマンドを実行してデフォルトの名前空間にアプリケーションを作成します。

   saectl apply -f deployment.yaml

3. 次のコマンドを実行して、作成したアプリケーションに関する情報を表示します。出力の STATE フィールドの値が RUNNING の場合、アプリケーションは実行中です。

   saectl get deployment ${deployment-name}
   # ${deployment-name} はアプリケーション名です。

4. 次のコマンドを実行して、作成したアプリケーションのインスタンス情報を表示します。

   saectl get pods -l sae.aliyun.com/app-name=${deployment-name}
   # ${deployment-name} はアプリケーション名です。

アプリケーションリストの表示

次のコマンドを実行して、指定した名前空間に存在するアプリケーションを表示します。

saectl get deployment -n ${namespace} 
# ${namespace} は名前空間の名前です。-n パラメーターを使用して名前空間を指定しない場合、デフォルトの名前空間が使用されます。

出力例は次のとおりです。

NAME              READY   AVAILABLE   TYPE        STATE     LANGUAGE   AGE
test-yaml   	  3/3     3           Image   	  RUNNING   java       6d1h
sc-c              2/2     2           Image       RUNNING   java       13d
sc-b              2/2     2           Image       RUNNING   java       13d
sc-a              1/1     1           Image       RUNNING   java       13d

次の表に、各フィールドの説明を示します。

アプリケーション詳細の表示

get または describe コマンドを使用して、アプリケーションの詳細を表示できます。

saectl get deployment ${deployment-name} -o yaml -n ${namespace}
# ${deployment-name} はアプリケーション名です。
# ${namespace} は名前空間の名前です。-n パラメーターを使用して名前空間を指定しない場合、デフォルトの名前空間が使用されます。

saectl describe deployment ${deployment-name} -n ${namespace}
# ${deployment-name} はアプリケーション名です。
# ${namespace} は名前空間の名前です。-n パラメーターを使用して名前空間を指定しない場合、デフォルトの名前空間が使用されます。

saectl scale deployment ${deployment-name} -n ${namespace} --replicas=${pod-num}
# ${deployment-name} はアプリケーション名です。
# ${namespace} は名前空間の名前です。-n パラメーターを使用して名前空間を指定しない場合、デフォルトの名前空間が使用されます。
# ${pod-num} は、目的のアプリケーションインスタンス数です。

saectl apply -f deployment.yaml

saectl delete deployment ${deployment-name} -n ${namespace}
# ${deployment-name} はアプリケーション名です。
# ${namespace} は名前空間です。-n パラメーターを使用して名前空間を指定しない場合、デフォルトの名前空間が使用されます。

アプリケーション用の新しい SLB インスタンスの作成

1. svc.yaml という名前のファイルを作成します。次のサンプルコードは、SLB 構成を含むファイルの内容を示しています。

   apiVersion: v1
   kind: Service
   metadata:
     name: internet-${deployment-name} # ${deployment-name} をアプリケーション名に置き換えます。
     # internet はパブリック SLB インスタンスを指定します。イントラネット SLB インスタンスを指定するには、intranet に置き換えます。
   spec:
     ports:
     - name: port-80
       port: 80 # アプリケーションへのアクセスに使用するポート。必要に応じて実際のポートに置き換えます。
       protocol: TCP
       targetPort: 80 # コンテナーが公開するポート。必要に応じて実際のポートに置き換えます。
     selector:
       sae.aliyun.com/app-name: ${deployment-name} # ${deployment-name} をアプリケーション名に置き換えます。

2. svc.yaml ファイルがあるディレクトリで、次のコマンドを実行してアプリケーション用の新しい SLB インスタンスを作成します。

   saectl apply -f svc.yaml

既存の SLB インスタンスへのアプリケーションのアタッチ

1. svc.yaml という名前のファイルを作成します。次のサンプルコードは、SLB 構成を含むファイルの内容を示しています。

   apiVersion: v1
   kind: Service
   metadata:
     annotations:
       sae.aliyun.com/loadbalancer-id: ${your-slb-id} # ${your-slb-id} を SLB ID に置き換えます。
     name: internet-${deployment-name} # ${deployment-name} をアプリケーション名に置き換えます。
     # internet はパブリック SLB インスタンスを指定します。イントラネット SLB インスタンスを指定するには、intranet に置き換えます。
   spec:
     ports:
     - name: port-80
       port: 80 # アプリケーションへのアクセスに使用するポート。必要に応じて実際のポートに置き換えます。
       protocol: TCP
       targetPort: 80 # コンテナーが公開するポート。必要に応じて実際のポートに置き換えます。
     selector:
       sae.aliyun.com/app-name: ${deployment-name} # ${deployment-name} をアプリケーション名に置き換えます。

2. svc.yaml ファイルがあるディレクトリで、次のコマンドを実行してアプリケーションを既存の SLB インスタンスにアタッチします。

   saectl apply -f svc.yaml

SLB インスタンスリストの表示

次のコマンドを実行して、既存の SLB インスタンスのリストを表示します。

saectl get service -l sae.aliyun.com/app-name=${deployment-name} -n ${namespace}
# ${deployment-name} はアプリケーション名です。-l パラメーターを使用してアプリケーション名を指定しない場合、デフォルトですべてのアプリケーションにアタッチされている SLB インスタンスが表示されます。
# ${namespace} は名前空間の名前です。-n パラメーターを使用して名前空間を指定しない場合、デフォルトの名前空間が使用されます。

出力例は次のとおりです。

NAME               TYPE         EXTERNAL-IP    PORT(S)   BOUND     AGE
internet-myapp   LoadBalancer   xxx.x.xx.xx    80/TCP    myapp    6d20h
intranet-myapp   LoadBalancer   xx.xx.xxx.xx   80/TCP    myapp    4d1h

次の表に、各フィールドの説明を示します。

SLB インスタンス詳細の表示

次のコマンドを実行して、SLB インスタンスの構成を表示します。

saectl get service ${service-name} -n ${namespace} -o yaml
# ${service-name} はサービス名です。
# ${namespace} は名前空間の名前です。-n パラメーターを使用して名前空間を指定しない場合、デフォルトの名前空間が使用されます。

SLB インスタンスの更新

edit または apply コマンドを使用して SLB インスタンスを更新できます。

saectl apply -f svc.yaml

SLB インスタンスのデタッチ

次のコマンドを実行して、指定した SLB インスタンスをデタッチします。

saectl delete service ${service-name} -n ${namespace}
# ${service-name} はサービス名です。
# ${namespace} は名前空間の名前です。-n パラメーターを使用して名前空間を指定しない場合、デフォルトの名前空間が使用されます。

ConfigMap の作成

1. cm.yaml という名前のファイルを作成します。次のサンプルコードは、ConfigMap 構成を含むファイルの内容を示しています。

   apiVersion: v1
   kind: ConfigMap
   metadata:
     name: database-configmap # ConfigMap の名前。
     namespace: default # ConfigMap が配置されている名前空間。
   data: # ConfigMap 内のキーと値のペア。
     database: mysql
     database_uri: mysql://localhost:2309

2. cm.yaml ファイルがあるディレクトリで、次のコマンドを実行して、デフォルトの名前空間に database-configmap という名前の ConfigMap を作成します。

   saectl apply -f cm.yaml

リージョン内の ConfigMap リストの表示

次のコマンドを実行して、リージョン内に存在する ConfigMap のリストを表示します。

saectl get configmap -A

出力例は次のとおりです。

NAMESPACE   NAME            DATA   AGE
default     nacos           1      69d
test        test-config     2      10d

次の表に、各フィールドの説明を示します。

名前空間内の ConfigMap リストの表示

次のコマンドを実行して、名前空間内に存在する ConfigMap のリストを表示します。

saectl get configmap -n ${namespace}
# ${namespace} は名前空間の名前です。-n パラメーターを使用して名前空間を指定しない場合、デフォルトの名前空間が使用されます。

ConfigMap 詳細の表示

次のコマンドを実行して、指定した ConfigMap の詳細を表示します。

saectl get cm ${cm-name} -n ${namespace} -o yaml 
# ${cm-name} は ConfigMap の名前です。
# ${namespace} は名前空間の名前です。-n パラメーターを使用して名前空間を指定しない場合、デフォルトの名前空間が使用されます。

コンテナー環境変数としての ConfigMap の参照

次のサンプルファイルは、ConfigMap をコンテナー環境変数として参照する方法を示しています。必要に応じて、キーと値のペアの一部またはすべてを参照できます。

apiVersion: apps/v1
kind: Deployment
metadata:
  name: test-configmap
  namespace: default
spec:
  replicas: 1
  selector:
    matchLabels:
      sae.aliyun.com/app-name: test-configmap
  template:
    metadata:
      creationTimestamp: null
      labels:
        sae.aliyun.com/app-name: test-configmap
    spec:
      containers:
      - args:
        - /home/admin/start.sh
        command:
        - /bin/bash
        env: ### 以下は、一部のキーと値のペアを参照する例です。
        - name: database # コンテナー内の環境変数の名前。
          valueFrom:
            configMapKeyRef: # 環境変数の値は、database-configmap の database キーの値を参照します。
              key: database
              name: database-configmap
        envFrom: ### 以下は、すべてのキーと値のペアを参照する例です。
        - configMapRef: # other-configmap 内のすべてのキーと値のペアは、コンテナー内の環境変数として参照されます。
            name: other-configmap
        name: main
        image: registry.cn-shenzhen.aliyuncs.com/sae-serverless-demo/sae-demo:microservice-java-provider-v1.0
        imagePullPolicy: Always
        resources:
          limits:
            cpu: "2"
            memory: 4Gi
          requests:
            cpu: "2"
            memory: 4Gi
      restartPolicy: Always
      terminationGracePeriodSeconds: 10

ファイルとしての ConfigMap のコンテナーへのマウント

次のサンプルファイルは、ConfigMap をファイルとしてコンテナーにマウントする方法を示しています。

apiVersion: apps/v1
kind: Deployment
metadata:
  name: test-configmap
  namespace: default
spec:
  replicas: 1
  selector:
    matchLabels:
      sae.aliyun.com/app-name: test-configmap
  template:
    metadata:
      labels:
        sae.aliyun.com/app-name: test-configmap
    spec:
      containers:
      - args:
        - /home/admin/start.sh
        command:
        - /bin/bash
        name: main
        image: registry.cn-shenzhen.aliyuncs.com/sae-serverless-demo/sae-demo:microservice-java-provider-v1.0
        imagePullPolicy: Always
        resources:
          limits:
            cpu: "2"
            memory: 4Gi
          requests:
            cpu: "2"
            memory: 4Gi
        volumeMounts:
          - mountPath: /tmp/nacos # ConfigMap ファイルのマウントパス。
            name: my-volume # マウントされたボリュームの名前は my-volume です。
      volumes: # nacos-configmap に基づいて my-volume を宣言します。
      - configMap:
          name: nacos-configmap
        name: my-volume
      restartPolicy: Always
      terminationGracePeriodSeconds: 10

ConfigMap の更新

edit または apply コマンドを使用して ConfigMap を更新できます。

saectl apply -f cm.yaml

ConfigMap の削除

次のコマンドを実行して、指定した ConfigMap を削除します。

saectl delete cm ${cm-name} -n ${namespace}
# ${cm-name} は ConfigMap の名前です。
# ${namespace} は名前空間の名前です。-n パラメーターを使用して名前空間を指定しない場合、デフォルトの名前空間が使用されます。