Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings
This repository was archived by the owner on Jul 22, 2024. It is now read-only.

Commit eeeddfc

Browse files
committed
Update to bx wsk
1 parent e88406b commit eeeddfc

File tree

15 files changed

+224
-180
lines changed

15 files changed

+224
-180
lines changed

‎.bluemix/pipeline.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@ stages:
2727
- name: MYSQL_DATABASE
2828
value: ${MYSQL_DATABASE}
2929
type: text
30-
- name: BLUEMIX_USERNAME
31-
value: ${BLUEMIX_USERNAME}
30+
- name: IBM_CLOUD_USERNAME
31+
value: ${IBM_CLOUD_USERNAME}
3232
type: text
33-
- name: BLUEMIX_PASSWORD
34-
value: ${BLUEMIX_PASSWORD}
33+
- name: IBM_CLOUD_PASSWORD
34+
value: ${IBM_CLOUD_PASSWORD}
3535
type: secure
36-
- name: BLUEMIX_NAMESPACE
37-
value: ${BLUEMIX_NAMESPACE}
36+
- name: IBM_CLOUD_NAMESPACE
37+
value: ${IBM_CLOUD_NAMESPACE}
3838
type: text
3939
jobs:
4040
- name: Deploy
@@ -72,9 +72,9 @@ stages:
7272
7373
echo "Logging in to Bluemix to create API service"
7474
./wsk bluemix login \
75-
--user $BLUEMIX_USERNAME \
76-
--password $BLUEMIX_PASSWORD \
77-
--namespace $BLUEMIX_NAMESPACE
75+
--user $IBM_CLOUD_USERNAME \
76+
--password $IBM_CLOUD_PASSWORD \
77+
--namespace $IBM_CLOUD_NAMESPACE
7878
7979
echo "Creating a package (here used as a namespace for shared environment variables)"
8080
./wsk package create cat \

‎.bluemix/toolchain.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ pipeline-serverless-apis:
3434
MYSQL_USERNAME: "{{deploy.parameters.mysql-username}}"
3535
MYSQL_PASSWORD: "{{deploy.parameters.mysql-password}}"
3636
MYSQL_DATABASE: "{{deploy.parameters.mysql-database}}"
37-
BLUEMIX_USERNAME: "{{deploy.parameters.bluemix-username}}"
38-
BLUEMIX_PASSWORD: "{{deploy.parameters.bluemix-password}}"
39-
BLUEMIX_NAMESPACE: "{{deploy.parameters.bluemix-namespace}}"
37+
IBM_CLOUD_USERNAME: "{{deploy.parameters.bluemix-username}}"
38+
IBM_CLOUD_PASSWORD: "{{deploy.parameters.bluemix-password}}"
39+
IBM_CLOUD_NAMESPACE: "{{deploy.parameters.bluemix-namespace}}"
4040
execute: false
4141

4242
deploy:

‎.travis.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
##############################################################################
2-
# Copyright 2017 IBM Corporation
2+
# Copyright 2017-2018 IBM Corporation
33
#
44
# Licensed under the Apache License, Version 2.0 (the "License");
55
# you may not use this file except in compliance with the License.
@@ -13,7 +13,7 @@
1313
# limitations under the License.
1414
##############################################################################
1515
language: bash
16-
sudo: true
16+
sudo: required
1717

1818
before_install:
1919
- sudo apt-get update -qq

‎CONTRIBUTING.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@ This is an open source project, and we appreciate your help!
44

55
We use the GitHub issue tracker to discuss new features and non-trivial bugs.
66

7-
In addition to the issue tracker, [#journeys on
8-
Slack](https://dwopen.slack.com) is the best way to get into contact with the
9-
project's maintainers.
10-
117
To contribute code, documentation, or tests, please submit a pull request to
128
the GitHub repository. Generally, we expect two maintainers to review your pull
139
request before it is approved for merging. For more details, see the

‎README-ja.md

Lines changed: 51 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
[![Build Status](https://travis-ci.org/IBM/ibm-cloud-functions-serverless-apis.svg?branch=master)](https://travis-ci.org/IBM/ibm-cloud-functions-serverless-apis)
2-
31
# IBM Cloud Functions でサーバーレス API ハンドラーを作成する (Apache OpenWhisk の利用)
42

3+
[![Build Status](https://travis-ci.org/IBM/ibm-cloud-functions-serverless-apis.svg?branch=master)](https://travis-ci.org/IBM/ibm-cloud-functions-serverless-apis)
4+
55
*Read this in other languages: [English](README.md), [한국어](README-ko.md).*
66

77
このプロジェクトは、サーバーレスのイベント駆動型アーキテクチャーの仕組みを説明するものです。このアーテクチャーでは、HTTP REST API の呼び出しにより、需要に応じてコードが実行されます。API エンドポイントが呼び出されるまでは、レスポンスにリソースは消費されません。API エンドポイントが呼び出されると、現在の負荷とちょうど一致するようにリソースがプロビジョニングされます。
@@ -43,22 +43,24 @@ OpenWhisk プログラミングモデルの基本的な理解が必要です。
4343
5. [こんどは手動でデプロイする](#5-recreate-deployment-manually)
4444

4545
<a name="1-provision-mysql"></a>
46-
# 1. MySQL の準備
46+
47+
## 1. MySQL の準備
4748

4849
IBM Cloudにログインし、[ClearDB](https://console.ng.bluemix.net/catalog/services/cleardb-mysql-database/) または [Compose for MySQL](https://console.ng.bluemix.net/catalog/services/compose-for-mysql/) データベースインスタンスを準備 (プロビジョニング) します。
4950
ClearDB には簡単なテストのためのフリーの段階 (tier) がありますが、Compose にはより大きなワークロードの段階があります。
5051

51-
* [ClearDB](https://console.ng.bluemix.net/catalog/services/cleardb-mysql-database/) の場合は、ClearDB ダッシュボードにログインし、作成されたデフォルトのデータベースを選択します。
52+
- [ClearDB](https://console.ng.bluemix.net/catalog/services/cleardb-mysql-database/) の場合は、ClearDB ダッシュボードにログインし、作成されたデフォルトのデータベースを選択します。
5253
`Endpoint Information` でユーザー、パスワード、およびホスト情報を取得します。
5354

54-
* [Compose for MySQL](https://console.ng.bluemix.net/catalog/services/compose-for-mysql/) の場合は、IBM Cloud コンソールの `Service Credentials` タブから情報を入手してください。
55+
- [Compose for MySQL](https://console.ng.bluemix.net/catalog/services/compose-for-mysql/) の場合は、IBM Cloud コンソールの `Service Credentials` タブから情報を入手してください。
5556

5657
`template.local.env` を `local.env` という名前の新しいファイルにコピーし、MySQL インスタンスの `MYSQL_HOSTNAME`、`MYSQL_USERNAME`、`MYSQL_PASSWORD`、`MYSQL_DATABASE` の値を書き込んでください。
5758

5859
> 訳者注: 2018年7月現在、ClearDB サービスは利用できないようですが、参考のためにテキストは翻訳します
5960
6061
<a name="2-create-openwhisk-actions-and-mappings"></a>
61-
# 2. OpenWhisk アクションとマッピングを作成する
62+
63+
## 2. OpenWhisk アクションとマッピングを作成する
6264

6365
`deploy.sh` は便利なスクリプトで、`local.env` から環境変数を読み込み、あなたのために OpenWhisk アクションと API マッピングを作成します。
6466
後でこれらのコマンドを自分で実行します。
@@ -71,7 +73,8 @@ ClearDB には簡単なテストのためのフリーの段階 (tier) があり
7173
[別のデプロイ方法](#alternative-deployment-methods) を参照することもできます。
7274

7375
<a name="3-test-api-endpoints"></a>
74-
# 3. APIエンドポイントをテストする
76+
77+
## 3. APIエンドポイントをテストする
7578

7679
`/v1/cat` エンドポイントに対して、エンティティを作成、取得、更新、削除する HTTP API クライアントをシミュレートする4つのヘルパースクリプトがあります。
7780

@@ -94,7 +97,8 @@ client/cat-delete.sh 1
9497
```
9598

9699
<a name="4-delete-actions-and-mappings"></a>
97-
# 4. アクションとマッピングを削除する
100+
101+
## 4. アクションとマッピングを削除する
98102

99103
`deploy.sh` をもう一度使って、OpenWhiskのアクションとマッピングを削除してください。
100104
次のセクションではそれらをステップバイステップで再作成します。
@@ -104,11 +108,12 @@ client/cat-delete.sh 1
104108
```
105109

106110
<a name="5-recreate-deployment-manually"></a>
107-
# 5. こんどは手動でデプロイする
111+
112+
## 5. こんどは手動でデプロイする
108113

109114
このセクションでは、`deploy.sh` スクリプトの実行内容を詳しく見て、OpenWhiskのトリガー、アクション、ルール、およびパッケージをより詳しく扱う方法を理解していきます。
110115

111-
## 5.1 猫データを変更するための OpenWhisk アクションの作成
116+
### 5.1 猫データを変更するための OpenWhisk アクションの作成
112117

113118
猫のデータを管理するアクションを API の各メソッド(POST、PUT、GET、DELETE)ごとに1つずつ、合計で4つ作成します。
114119
アクションのコードは `/actions` にあります。
@@ -118,22 +123,22 @@ client/cat-delete.sh 1
118123
追加パッケージが必要な場合は、アクションファイルとともに ZIP ファイルにまとめてアップロードすることができます。
119124
単一ファイルと ZIP 圧縮アーカイブの違いの詳細については、[Getting Started Guide](https://console.ng.bluemix.net/docs/openwhisk/openwhisk_actions.html#openwhisk_js_packaged_action) を参照してください。
120125

121-
### 5.1.1 猫パッケージ
126+
#### 5.1.1 猫パッケージ
122127

123128
すべてのアクションは MySQL データベースサービスに依存しているため、パッケージレベルで一度、資格情報を設定すると便利です。
124129
これにより、パッケージ内のすべてのアクションで資格情報を使用できるようになります。
125130
したがって、作成時および実行時にアクションごとに定義する必要はありません。
126131

127132
```bash
128133
source local.env
129-
wsk package create cat \
134+
bx wsk package create cat \
130135
--param "MYSQL_HOSTNAME" $MYSQL_HOSTNAME \
131136
--param "MYSQL_USERNAME" $MYSQL_USERNAME \
132137
--param "MYSQL_PASSWORD" $MYSQL_PASSWORD \
133138
--param "MYSQL_DATABASE" $MYSQL_DATABASE
134139
```
135140

136-
### 5.1.2 猫の作成アクション
141+
#### 5.1.2 猫の作成アクション
137142

138143
POSTアクションのJavaScriptコードは、 [`/actions/cat-post-action/index.js`](actions/cat-post-action/index.js) にあります。
139144
この関数は、データベースに接続するために必要な `mysql` クライアント npm パッケージに依存します。
@@ -149,7 +154,7 @@ zip -rq action.zip *
149154

150155
```bash
151156
# Create
152-
wsk action create cat/cat-post \
157+
bx wsk action create cat/cat-post \
153158
--kind nodejs:6 action.zip \
154159
--web true
155160
```
@@ -158,7 +163,7 @@ wsk action create cat/cat-post \
158163

159164
```bash
160165
# Test
161-
wsk action invoke \
166+
bx wsk action invoke \
162167
--blocking \
163168
--param name Tarball \
164169
--param color Black \
@@ -169,10 +174,9 @@ wsk action invoke \
169174
170175
上記の手順を繰り返して、対応する GET、PUT、DELETE アクションを作成してテストしていきます。
171176

172-
173177
> **注**: 上記の POST アクション結果から返された実際の ID を反映させるために、あなたのテストでは `id 1` を置き換えてください。
174178
175-
### 5.1.3 猫の参照アクション
179+
#### 5.1.3 猫の参照アクション
176180

177181
GET アクションを作成してテストします。
178182

@@ -181,20 +185,20 @@ GET アクションを作成してテストします。
181185
cd ../../actions/cat-get-action
182186
npm install
183187
zip -rq action.zip *
184-
wsk action create cat/cat-get \
188+
bx wsk action create cat/cat-get \
185189
--kind nodejs:6 action.zip \
186190
--web true
187191

188192
# Test
189-
wsk action invoke \
193+
bx wsk action invoke \
190194
--blocking \
191195
--param id 1 \
192196
cat/cat-get
193197
```
194198

195199
> 訳者注: このアクションで、さきほど作成された「名前が Tarball で、色が黒」である猫のレコードが読み取られ表示されるはずです。
196200
197-
### 5.1.4 猫の更新アクション
201+
#### 5.1.4 猫の更新アクション
198202

199203
PUT アクションを作成してテストします。
200204

@@ -203,27 +207,27 @@ PUT アクションを作成してテストします。
203207
cd ../../actions/cat-put-action
204208
npm install
205209
zip -rq action.zip *
206-
wsk action create cat/cat-put \
210+
bx wsk action create cat/cat-put \
207211
--kind nodejs:6 action.zip \
208212
--web true
209213

210214
# Test
211-
wsk action invoke \
215+
bx wsk action invoke \
212216
--blocking \
213217
--param name Tarball \
214218
--param color Gray \
215219
--param id 1 \
216220
cat/cat-put
217221

218-
wsk action invoke \
222+
bx wsk action invoke \
219223
--blocking \
220224
--param id 1 \
221225
cat/cat-get
222226
```
223227

224228
> 訳者注: このアクションで、さきほど作成・参照された「名前が Tarball で、色が黒」である猫のレコードが、「名前が Tarball で、色が灰色」に書き換えられました。
225229
226-
### 5.1.5 猫の削除アクション
230+
#### 5.1.5 猫の削除アクション
227231

228232
DELETE アクションを作成してテストします。
229233

@@ -232,34 +236,34 @@ DELETE アクションを作成してテストします。
232236
cd ../../actions/cat-delete-action
233237
npm install
234238
zip -rq action.zip *
235-
wsk action create cat/cat-delete \
239+
bx wsk action create cat/cat-delete \
236240
--kind nodejs:6 action.zip \
237241
--web true
238242

239243
# Test
240-
wsk action invoke \
244+
bx wsk action invoke \
241245
--blocking \
242246
--param id 1 \
243247
cat/cat-delete
244248

245-
wsk action invoke \
249+
bx wsk action invoke \
246250
--blocking \
247251
--param id 1 \
248252
cat/cat-get
249253
```
250254

251255
> 訳者注: このアクションで、さきほど作成・参照・更新された「名前が Tarball で、色が灰色」である猫のレコードが、削除されました。
252256
253-
## 5.2 REST APIエンドポイントを作成する
257+
### 5.2 REST APIエンドポイントを作成する
254258

255259
次に、リソースエンドポイント (`/cat`) を `GET`、`DELETE`、`PUT`、`POST` HTTP メソッドにマップし、対応する OpenWhisk アクションに関連づけて、クライアントスクリプトを使ってテストします。
256260

257261
```bash
258262
# Create
259-
wsk api create -n "Cats API" /v1 /cat post cat/cat-post
260-
wsk api create /v1 /cat put cat/cat-put
261-
wsk api create /v1 /cat get cat/cat-get
262-
wsk api create /v1 /cat delete cat/cat-delete
263+
bx wsk api create -n "Cats API" /v1 /cat post cat/cat-post
264+
bx wsk api create /v1 /cat put cat/cat-put
265+
bx wsk api create /v1 /cat get cat/cat-get
266+
bx wsk api create /v1 /cat delete cat/cat-delete
263267

264268
# Test
265269

@@ -276,34 +280,36 @@ client/cat-put.sh 1 Tarball Gray
276280
client/cat-delete.sh 1
277281
```
278282

279-
## 5.3 クリーンアップ
283+
### 5.3 クリーンアップ
280284

281285
APIマッピングを解除し、アクションを削除します。
282286

283287
```bash
284-
wsk api delete /v1
285-
wsk action delete cat/cat-post
286-
wsk action delete cat/cat-put
287-
wsk action delete cat/cat-get
288-
wsk action delete cat/cat-delete
289-
wsk package delete cat
288+
bx wsk api delete /v1
289+
bx wsk action delete cat/cat-post
290+
bx wsk action delete cat/cat-put
291+
bx wsk action delete cat/cat-get
292+
bx wsk action delete cat/cat-delete
293+
bx wsk package delete cat
290294
```
291295

292296
<a name="troubleshooting"></a>
293-
# トラブルシューティング
297+
298+
## トラブルシューティング
294299

295300
まずは OpenWhisk アクティベーションログでエラーをチェックしてください。
296-
`wsk activation poll` を使用してコマンドラインでログを出力するか、[IBM Cloudの監視コンソール](https://console.ng.bluemix.net/openwhisk/dashboard) で視覚的に細部を掘り下げてください。
301+
`bx wsk activation poll` を使用してコマンドラインでログを出力するか、[IBM Cloudの監視コンソール](https://console.ng.bluemix.net/openwhisk/dashboard) で視覚的に細部を掘り下げてください。
297302

298303
エラー内容が不明確な場合は、[最新バージョンの `wsk` CLI](https://console.ng.bluemix.net/openwhisk/learn/cli) がインストールされていることを確認してください。
299304
もし数週間以上経過している場合は、アップデートをダウンロードしてください。
300305

301306
```bash
302-
wsk property get --cliversion
307+
bx wsk property get --cliversion
303308
```
304309

305310
<a name="alternative-deployment-methods"></a>
306-
# 別のデプロイ方法
311+
312+
## 別のデプロイ方法
307313

308314
`deploy.sh` は将来、[`wskdeploy`](https://github.com/openwhisk/openwhisk-wskdeploy) に置き換えられます。 `wskdeploy` は、宣言されたトリガー、アクション、ルールを OpenWhisk にデプロイするためにマニフェスト (manifest) を使います。
309315

@@ -312,5 +318,6 @@ OpenWhisk と MySQL の資格情報を Delivery Pipeline アイコンの下に
312318

313319
[![Deploy to the IBM Cloud](https://bluemix.net/deploy/button.png)](https://bluemix.net/deploy?repository=https://github.com/IBM/openwhisk-serverless-apis.git)
314320

315-
# ライセンス
321+
## ライセンス
322+
316323
[Apache 2.0](LICENSE)

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /