8.6. 3scale OpenAPI カスタムリソースのデプロイ

手順

1. OAS ドキュメントが含まれるシークレットを定義します。たとえば、以下の内容で myoasdoc1.yaml を作成することができます。

   openapi: "3.0.2"
   info:
     title: "some title"
     description: "some description"
     version: "1.0.0"
   paths:
     /pet:
       get:
         operationId: "getPet"
         responses:
           405:
             description: "invalid input"

   Copy to Clipboard Toggle word wrap

2. シークレットを作成します。以下に例を示します。

   $ oc create secret generic myoasdoc1 --from-file myoasdoc1.yaml
   
   secret/myoasdoc1 created

   Copy to Clipboard Toggle word wrap

3. OpenAPI CR を定義します。OAS ドキュメントが含まれるシークレットへの参照を指定するようにしてください。たとえば、myopenapicr1.yaml ファイルを作成することができます。

   apiVersion: capabilities.3scale.net/v1beta1
   kind: OpenAPI
   metadata:
     name: myopenapicr1
   spec:
     openapiRef:
       secretRef:
         name: myoasdoc1

   Copy to Clipboard Toggle word wrap

4. 定義したばかりのリソースを作成します。以下に例を示します。

   $ oc create -f myopenapicr1.yaml

   Copy to Clipboard Toggle word wrap

   この例では、出力は以下のようになります。

   openapi.capabilities.3scale.net/myopenapicr1 created

   Copy to Clipboard Toggle word wrap

手順

1. OpenShift アカウントで、Operators > Installed operators に移動します。
2. 3scale operator をクリックします。
3. YAML タブを選択します。

4. OpenAPI カスタムリソースを作成します。以下に例を示します。

   apiVersion: capabilities.3scale.net/v1beta1
   kind: OpenAPI
   metadata:
     name: openapi1
   spec:
     openapiRef:
       url: "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml"
     providerAccountRef:
       name: mytenant

   Copy to Clipboard Toggle word wrap
5. Save をクリックします。3scale operator が OpenAPI CR を作成するまでに数秒かかります。

検証

1. OpenShift の 3scale Product Overview ページで、Synced 状態が True とマークされていることを確認します。
2. 3scale アカウントに移動します。
3. OAS ドキュメントが存在することを確認します。上記の例では、openapi1 という名前の新しい OAS ドキュメントが表示されます。