Skip to content

Commit 42adbfe

Browse files
kimhkimh
authored
Ja translation 20190518 (circleci#3391)
1 parent 375053f commit 42adbfe

File tree

7 files changed

+646
-1
lines changed

7 files changed

+646
-1
lines changed

‎jekyll/_cci2_ja/ecs-ecr.md

Lines changed: 168 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,168 @@
1+
---
2+
layout: classic-docs
3+
title: AWS ECR/ECS へのデプロイ
4+
description: CircleCI を使用した AWS ECR から ECS へのデプロイ方法
5+
---
6+
7+
ここでは、CircleCI を使用して、Amazon Elastic Container Registry (ECR) から Amazon Elastic Container Service (ECS) へデプロイする方法を説明します。
8+
9+
- 目次
10+
{:toc}
11+
12+
## 概要
13+
14+
このガイドは、次の 2段階に分かれています。
15+
16+
- Docker イメージをビルドして AWS ECR にプッシュする
17+
- 新しい Docker イメージを既存の AWS ECS サービスにデプロイする
18+
19+
また、アプリケーションの [CircleCI でのビルド](https://circleci.com/gh/CircleCI-Public/circleci-demo-aws-ecs-ecr){:rel="nofollow"}についても触れています。
20+
21+
**メモ：**このプロジェクトには、簡単な [Dockerfile](https://github.com/CircleCI-Public/circleci-demo-aws-ecs-ecr/blob/master/Dockerfile) が含まれています。
22+
23+
詳細については、「[カスタムイメージの手動作成]({{ site.baseurl }}/ja/2.0/custom-images/#カスタムイメージの手動作成)」を参照してください。
24+
25+
## 前提条件
26+
27+
### Terraform を使用して AWS リソースを作成する
28+
29+
このガイドに沿ってアプリケーションをビルドしてデプロイするには、いくつかの AWS リソースが必要です。 CircleCI では、これらのリソースを作成するために[いくつかの Terraform スクリプト](https://github.com/CircleCI-Public/circleci-demo-aws-ecs-ecr/tree/master/terraform_setup)を提供しています。 これらのスクリプトを使用するには、以下の手順を行います。
30+
31+
1. [AWS アカウントを作成します](https://aws.amazon.com/jp/premiumsupport/knowledge-center/create-and-activate-aws-account/)。
32+
2. [Terraform をインストールします](https://www.terraform.io/)。
33+
3. [サンプルプロジェクト](https://github.com/CircleCI-Public/circleci-demo-aws-ecs-ecr)のクローンを作成し、そのルートディレクトリに移動します。
34+
4. AWS 変数の実際の値で `~/terraform_setup/terraform.tfvars` を更新します。 詳細については、以下の「[CircleCI 環境変数を設定する](#circleci-環境変数を設定する)」セクションを参照してください。
35+
5. 以下のコマンドを実行して、AWS リソースを作成します。
36+
37+
```bash
38+
cd terraform_setup
39+
terraform init
40+
terraform plan # プランをレビュー
41+
terraform apply # プランを適用して AWS リソースを作成
42+
```
43+
44+
**メモ：**ほとんどの AWS リソースは、`terraform destroy` を実行することで破棄できます。 リソースが残っている場合は、[AWS マネジメントコンソール](https://console.aws.amazon.com/)、特に **ECS**、**CloudFormation**、**VPC** のページを確認してください。
45+
46+
### CircleCI 環境変数を設定する
47+
48+
CircleCI アプリケーションで、以下の[プロジェクト環境変数]({{ site.baseurl }}/ja/2.0/env-vars/#プロジェクト内で環境変数を設定する)を設定します。
49+
50+
変数 | 説明
51+
-------------------------|------------
52+
AWS_ACCESS_KEY_ID | AWS のセキュリティ認証情報です。
53+
AWS_SECRET_ACCESS_KEY | AWS のセキュリティ認証情報です。
54+
AWS_DEFAULT_REGION | AWS CLI によって使用されます。
55+
AWS_ACCOUNT_ID | デプロイに必要です。 [AWS アカウント ID はこちらで確認してください](https://docs.aws.amazon.com/ja_jp/IAM/latest/UserGuide/console_account-alias.html#FindingYourAWSId)。
56+
AWS_RESOURCE_NAME_PREFIX | 必須の AWS リソースのプレフィックスです。 `terraform_setup/terraform.tfvars` の `aws_resource_prefix` の値に対応する必要があります。
57+
{:class="table table-striped"}
58+
59+
## 設定の詳細説明
60+
61+
すべての CircleCI プロジェクトには、[`.circleci/config.yml`]({{ site.baseurl }}/ja/2.0/configuration-reference/) という設定ファイルが必要です。 以下の手順に従って、完全な `config.yml` ファイルを作成してください。
62+
63+
**メモ：**このセクションで説明するサンプルプロジェクトは、以下で提供されている CircleCI の AWS-ECR Orb と AWS-ECS Orb を使用します。
64+
- [AWS-ECR](https://circleci.com/orbs/registry/orb/circleci/aws-ecr)
65+
- [AWS-ECS](https://circleci.com/orbs/registry/orb/circleci/aws-ecs)
66+
67+
### Docker イメージをビルドして AWS ECR にプッシュする
68+
69+
`build_and_push_image` ジョブは、デフォルトの場所 (チェックアウトディレクトリのルート) に Dockerfile から Docker イメージをビルドし、それを指定された ECR リポジトリにプッシュします。
70+
71+
```yaml
72+
version: 2.1
73+
orbs:
74+
aws-ecr: circleci/[email protected]
75+
aws-ecs: circleci/[email protected]
76+
workflows:
77+
build-and-deploy:
78+
jobs:
79+
- aws-ecr/build_and_push_image:
80+
account-url: "${AWS_ACCOUNT_ID}.dkr.ecr.${AWS_DEFAULT_REGION}
81+
.amazonaws.com"
82+
repo: "${AWS_RESOURCE_NAME_PREFIX}"
83+
region: ${AWS_DEFAULT_REGION}
84+
tag: "${CIRCLE_SHA1}"
85+
- ...
86+
```
87+
88+
### 新しい Docker イメージを既存の AWS ECS サービスにデプロイする
89+
90+
aws-ecs Orb の `deploy-service-update` ジョブは、現在のタスク定義に基づきつつ、タスク定義のコンテナ定義で指定された新しい Docker イメージを使用して新しいタスク定義を作成し、この新しいタスク定義を指定された ECS サービスにデプロイします。 CircleCI AWS-ECS Orb の詳細については、https://circleci.com/orbs/registry/orb/circleci/aws-ecs を参照してください。
91+
92+
**メモ：**`deploy-service-update` ジョブは、`requires` キーがあるため、`build_and_push_image` に依存します。
93+
94+
```yaml
95+
version: 2.1
96+
orbs:
97+
aws-ecr: circleci/[email protected]
98+
aws-ecs: circleci/[email protected]
99+
workflows:
100+
build-and-deploy:
101+
jobs:
102+
- ...
103+
- aws-ecs/deploy-service-update:
104+
requires:
105+
- aws-ecr/build_and_push_image
106+
aws-region: ${AWS_DEFAULT_REGION}
107+
family: "${AWS_RESOURCE_NAME_PREFIX}-service"
108+
cluster-name: "${AWS_RESOURCE_NAME_PREFIX}-cluster"
109+
container-image-name-updates: "container=${AWS_RESOURCE_NAME_PREFIX}-service,tag=${CIRCLE_SHA1}"
110+
```
111+
112+
### ワークフローを準備する
113+
114+
ワークフローを使用して、`build_and_push_image` ジョブと `deploy-service-update` ジョブをリンクします。
115+
116+
```yaml
117+
version: 2.1
118+
orbs:
119+
aws-ecr: circleci/[email protected]
120+
aws-ecs: circleci/[email protected]
121+
workflows:
122+
build-and-deploy:
123+
jobs:
124+
- aws-ecr/build_and_push_image:
125+
account-url: "${AWS_ACCOUNT_ID}.dkr.ecr.${AWS_DEFAULT_REGION}
126+
.amazonaws.com"
127+
repo: "${AWS_RESOURCE_NAME_PREFIX}"
128+
region: ${AWS_DEFAULT_REGION}
129+
tag: "${CIRCLE_SHA1}"
130+
- aws-ecs/deploy-service-update:
131+
requires:
132+
- aws-ecr/build_and_push_image
133+
aws-region: ${AWS_DEFAULT_REGION}
134+
family: "${AWS_RESOURCE_NAME_PREFIX}-service"
135+
cluster-name: "${AWS_RESOURCE_NAME_PREFIX}-cluster"
136+
container-image-name-updates: "container=${AWS_RESOURCE_NAME_PREFIX}-service,tag=${CIRCLE_SHA1}"
137+
```
138+
139+
詳細については、[ワークフローを使用したジョブのスケジュール]({{ site.baseurl }}/ja/2.0/workflows/)を参照してください。
140+
141+
## 完全な設定ファイル
142+
143+
```yaml
144+
version: 2.1
145+
orbs:
146+
aws-ecr: circleci/[email protected]
147+
aws-ecs: circleci/[email protected]
148+
workflows:
149+
build-and-deploy:
150+
jobs:
151+
- aws-ecr/build_and_push_image:
152+
account-url: "${AWS_ACCOUNT_ID}.dkr.ecr.${AWS_DEFAULT_REGION}.amazonaws.com"
153+
repo: "${AWS_RESOURCE_NAME_PREFIX}"
154+
region: ${AWS_DEFAULT_REGION}
155+
tag: "${CIRCLE_SHA1}"
156+
- aws-ecs/deploy-service-update:
157+
requires:
158+
- aws-ecr/build_and_push_image
159+
aws-region: ${AWS_DEFAULT_REGION}
160+
family: "${AWS_RESOURCE_NAME_PREFIX}-service"
161+
cluster-name: "${AWS_RESOURCE_NAME_PREFIX}-cluster"
162+
container-image-name-updates: "container=${AWS_RESOURCE_NAME_PREFIX}-service,tag=${CIRCLE_SHA1}"
163+
```
164+
165+
## 関連項目
166+
167+
- Docker イメージをビルドおよびテストして ECR にプッシュした後で、`aws-ecs` Orb を使用して更新をデプロイする例をレビューするには、[AWS-ECS-ECR Orbs](https://github.com/CircleCI-Public/circleci-demo-aws-ecs-ecr/tree/orbs) のデモページにアクセスしてください。
168+
- CircleCI Orbs を使用しない例をレビューするには、[Non-Orbs AWS ECR-ECS](https://github.com/CircleCI-Public/circleci-demo-aws-ecs-ecr/tree/without_orbs) のデモページにアクセスしてください。

‎jekyll/_cci2_ja/enable-checks.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
---
2+
layout: classic-docs
3+
title: "GitHub Checks の有効化"
4+
short-title: "GitHub Checks の有効化"
5+
description: "CircleCI で GitHub Checks を有効にする方法"
6+
categories: [getting-started]
7+
order: 1
8+
---
9+
10+
ここでは、CircleCI の設定で GitHub Checks を有効にし、CircleCI Checks アプリがワークフローステータスを GitHub アプリに報告するのを許可する方法を説明します。
11+
12+
## 概要
13+
14+
GitHub Checks は、GitHub の [Checks] ページにワークフローステータスに関するメッセージを表示し、GitHub の [Checks] ページからワークフローを再実行できるようにします。
15+
16+
Checks が有効になると、CircleCI のワークフローおよびジョブのステータスが GitHub の [Checks] タブに報告されます。
17+
18+
![CircleCI Checks]({{ site.baseurl }}/assets/img/docs/checks_tab.png)
19+
20+
## GitHub Checks を有効にする方法
21+
22+
CircleCI Check インテグレーションを使用するには、[Org Setting (組織の設定)] に移動して、以下のように CircleCI Checks を使用するリポジトリを認証します。
23+
24+
### 前提条件
25+
26+
- プロジェクトで、[Workflows ]({{ site.baseurl }}/ja/2.0/workflows/)機能を備えた CircleCI 2.0 を使用している必要があります。
27+
- CircleCI Checks インテグレーションのインストールを許可するには、GitHub リポジトリの管理者でなければなりません。
28+
29+
### 手順
30+
31+
1. CircleCI アプリのメインメニューで [Settings (設定)] タブをクリックします。
32+
2. [VCS] を選択します。
33+
3. [Manage GitHub Checks (GitHub Checks を管理)] ボタンをクリックします。![CircleCI の VCS 設定ページ]({{ site.baseurl }}/assets/img/docs/checks_setting.png)
34+
4. Checks を利用するリポジトリを選択し、[Install (インストール)] ボタンをクリックします。 ![CircleCI の VCS 設定ページ]({{ site.baseurl }}/assets/img/docs/checks_install.png)
35+
インストールが完了すると、GitHub の [Checks] タブにワークフローの実行ステータス情報が表示されます。
36+
37+
## Checks によるステータスレポート
38+
39+
CircleCI は、ワークフローとすべての対応するジョブのステータスを GitHub の [Checks] タブで報告します。 また、Checks によって、GitHub の [Checks] タブから各ワークフローを再実行するためのボタンも用意されます。
40+
41+
再実行が開始されると、CircleCI は、ワークフローを最初から再実行し、ステータスを [Checks] タブに再送します。 GitHub から CircleCI アプリに移動するには、[View more details on CircleCI Checks (CircleCI Checks で詳細を確認する)] リンクをクリックします。
42+
43+
**メモ：**GitHub Checks をオンにすると、その後、プロジェクトはジョブレベルのステータスを受け取らなくなります。 これは、[Project Settings (プロジェクト設定)] > [Advanced Settings (詳細設定)] ページの [GitHub Status updates (GitHub ステータスアップデート)] セクションで変更できます。
44+
45+
## プロジェクトの GitHub Checks を無効にする方法
46+
47+
CircleCI Check インテグレーションを無効にするには、[Org Settings (組織の設定)] ページに移動した後、以下の手順に従って CircleCI Checks を使用しているリポジトリを削除します。
48+
49+
### 手順
50+
51+
1. CircleCI アプリのメインメニューで [Settings (設定)] タブをクリックします。
52+
2. [VCS] を選択します。
53+
3. [Manage GitHub Checks (GitHub Checks を管理)] ボタンをクリックします。 [Update CircleCI Checks repository access (CircleCI Checks のリポジトリアクセスの更新)] ページが表示されます。 ![CircleCI の VCS 設定ページ]({{ site.baseurl }}/assets/img/docs/checks_update.png)
54+
4. Checks インテグレーションをアンインストールするリポジトリの選択を解除します。
55+
5. プロジェクトでステータスの設定を確認します。[CircleCI] > [Project Settings (プロジェクト設定)] > [Advanced Settings (詳細設定)] に移動し、[GitHub Status Updates (GitHub ステータスアップデート)]`` が `on` に設定されていることを確認します。
56+
57+
![GitHub ステータスの再有効化]({{ site.baseurl }}/assets/img/docs/github-checks-enable-updates.png)
58+
59+
## 組織の Checks をアンインストールする方法
60+
61+
1. CircleCI アプリのメインメニューで [Settings (設定)] タブをクリックします。
62+
2. [VCS] を選択します。
63+
3. [Manage GitHub Checks (GitHub Checks を管理)] ボタンをクリックします。
64+
4. 下へスクロールして、[Uninstall (アンインストール)] ボタンをクリックし、GitHub Checks アプリをアンインストールします。
65+
66+
## GitHub Checks が GitHub でステータスを待機している場合
67+
68+
`ci/circleci:build — ステータスの報告を待機`
69+
70+
GitHub リポジトリで GitHub Checks を有効にしているものの、GitHub の [Checks] タブでステータスチェックがいつまでも完了しない場合は、GitHub でいずれかのステータス設定を解除する必要がある可能性があります。 たとえば、ブランチの保護を選択している場合は、以下に示すように `ci/circleci:build` ステータスキーの選択を解除する必要があります。これは、このキーが選択されていると CircleCI 2.0 のジョブステータスが参照されるためです。
71+
72+
![GitHub ジョブステータスキーの選択の解除]({{ site.baseurl }}/assets/img/docs/github_job_status.png)
73+
74+
GitHub Checks を使用している際に、`ci/circleci:build` チェックボックスをオンにすると、GitHub でステータスが完了と表示されなくなります。これは CircleCI が GitHub にステータスをワークフロージョブレベルではなくワークフローレベルで送信するためです。
75+
76+
GitHub で [Settings (設定)] > [Branches (ブランチ)] に移動し、保護されているブランチで [Edit (編集)] ボタンをクリックして、設定の選択を解除します (例：`https://github.com/your-org/project/settings/branches`)。

‎jekyll/_cci2_ja/examples-intro.md

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
---
2+
layout: classic-docs
3+
title: "サンプル"
4+
short-title: "サンプル"
5+
description: "CircleCI 2.0 サンプルの紹介"
6+
categories: [migration]
7+
order: 1
8+
---
9+
10+
11+
CircleCI を使用して、Linux、Android、iOS 上で動作するアプリケーションをビルド、テスト、およびデプロイすることができます。 以下のスニペットでは、各プラットフォーム用にジョブの設定をカスタマイズする方法に重点を置いて解説しています。 1つの [`.circleci/config.yml`]({{ site.baseurl }}/ja/2.0/configuration-reference/) ファイルで、複数のプラットフォーム上で動作するジョブを設定することも可能です。
12+
13+
## Linux と Docker
14+
15+
{% raw %}
16+
17+
```yaml
18+
version: 2
19+
jobs:
20+
build:
21+
working_directory: ~/mern-starter
22+
# プライマリコンテナは、最初にリストしたイメージのインスタンスです。 ジョブのコマンドは、このコンテナ内で実行されます。
23+
docker:
24+
- image: circleci/node:4.8.2-jessie
25+
# セカンダリコンテナは、2番目にリストしたイメージのインスタンスです。プライマリコンテナ上に公開されているポートをローカルホストで利用できる共通ネットワーク内で実行されます。
26+
- image: mongo:3.4.4-jessie
27+
steps:
28+
- checkout
29+
- run:
30+
name: npm を更新
31+
command: 'sudo npm install -g npm@latest'
32+
- restore_cache:
33+
key: dependency-cache-{{ checksum "package.json" }}
34+
- run:
35+
name: npm wee をインストール
36+
command: npm install
37+
- save_cache:
38+
key: dependency-cache-{{ checksum "package.json" }}
39+
paths:
40+
- node_modules
41+
```
42+
43+
{% endraw %}
44+
45+
## Linux と Machine
46+
47+
**メモ：**将来の料金改定では、Machine の使用に追加料金が必要になる可能性があります。
48+
49+
デフォルトのマシンイメージを使用して Machine Executor を使用するには、`.circleci/config.yml` で machine キーを true に設定します。
50+
51+
```yaml
52+
version: 2
53+
jobs:
54+
build:
55+
machine: true
56+
```
57+
58+
## Android
59+
60+
{% raw %}
61+
62+
```yaml
63+
version: 2
64+
jobs:
65+
build:
66+
working_directory: ~/code
67+
docker:
68+
- image: circleci/android:api-25-alpha
69+
environment:
70+
JVM_OPTS: -Xmx3200m
71+
steps:
72+
- checkout
73+
- restore_cache:
74+
key: jars-{{ checksum "build.gradle" }}-{{ checksum "app/build.gradle" }}
75+
# - run:
76+
# name: Chmod パーミッション # Gradlew Dependencies のパーミッションが失敗する場合は、これを使用します。
77+
# command: sudo chmod +x ./gradlew
78+
- run:
79+
name: 依存関係をダウンロード
80+
command: ./gradlew androidDependencies
81+
```
82+
83+
{% endraw %}
84+
85+
## iOS
86+
87+
jobs:
88+
build-and-test:
89+
macos:
90+
xcode: "9.3.0"
91+
steps:
92+
...
93+
- run:
94+
name: テストを実行
95+
command: fastlane scan
96+
environment:
97+
SCAN_DEVICE: iPhone 6
98+
SCAN_SCHEME: WebTests
99+
100+
101+
102+
## 関連項目
103+
104+
上記のサンプルで使用されている Executor タイプの詳細については、[こちら]({{ site.baseurl }}/ja/2.0/executor-types/)を参照してください。

‎jekyll/_cci2_ja/executor-intro.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
layout: classic-docs
3+
title: "Executor とイメージ"
4+
short-title: "Executor とイメージ"
5+
description: "CircleCI 2.0 の Executor とイメージ"
6+
categories: [configuration]
7+
order: 1
8+
---
9+
10+
`docker`、`machine`、または `macos` Executor で実行するビルド環境を準備し、必要なツールとパッケージのみを含むイメージを指定します。
11+
12+
## Docker
13+
14+
jobs:
15+
build: # ジョブの名前
16+
docker: # Executor タイプ
17+
- image: buildpack-deps:trusty # プライマリコンテナが Ubuntu Trusty を実行します
18+
19+
20+
## Machine
21+
22+
jobs:
23+
build:
24+
machine:
25+
image: circleci/classic:201708-01 # VM はこのリリース日の Ubuntu 14.04 を実行します
26+
27+
28+
## macOS
29+
30+
jobs:
31+
build:
32+
macos:
33+
xcode: "9.0"
34+
35+
steps:
36+
# コマンドは、インストールされている Xcode 9.0 を
37+
# 使用して、macOS コンテナ内で動作します
38+
- run: xcodebuild -version
39+
40+
41+
## 関連項目
42+
43+
ビルド済み CircleCI コンビニエンスイメージの詳細については、[こちら]({{ site.baseurl }}/ja/2.0/circleci-images/)を参照してください。

0 commit comments

Comments
 (0)