Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

co情報とキャプチャ画像を追加 #185

Merged
merged 5 commits into from
Apr 13, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 22 additions & 1 deletion _data/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,30 @@ docs:
- title: ec-cube.co
output: web, pdf
children:
- title: ec-cube.co
- title: ec-cube.coとは
url: /co
output: web, pdf
- title: アップデート指針
url: /co/co_update_guidelines
output: web, pdf
- title: Console
url: /co/co_console
output: web, pdf
- title: ネーミングルール
url: /co/co_naming_rules
output: web, pdf
- title: Git管理機能の仕様
url: /co/co_git
output: web, pdf
- title: カスタマイズディレクトリ利用方法
url: /co/co_customize_dir_usage
output: web, pdf
- title: テスト環境の構築
url: /co/co_staging
output: web, pdf
- title: ログの取得
url: /co/co_log
output: web, pdf
- title: インストール方法
output: web, pdf
children:
Expand Down
22 changes: 22 additions & 0 deletions _pages/co/co_console.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: ec-cube.co Console
keywords: co ec-cube.co クラウド版 Console コンソール
tags: [co, ec-cube.co]
permalink: co/co_console
folder: co
---


---

## コンソール管理画面について

コンソール管理画面にログインすると環境情報や契約情報を確認できます。
コンソール管理画面にログインする際はPCのChromeブラウザをご使用下さい。
<br>
スタンダードプランの場合、以下の表示と使用が可能になります。

- 「テスト環境」、「Gitリポジトリ」項目の表示
- サイドメニューの「ログ」、「テスト環境」の使用

![console_standard](/images/co/console_standard.png)
97 changes: 97 additions & 0 deletions _pages/co/co_customize_dir_usage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
---
title: ec-cube.co カスタマイズディレクトリ利用方法
keywords: co ec-cube.co クラウド版 カスタマイズディレクトリ利用方法
tags: [co, ec-cube.co]
permalink: co/co_customize_dir_usage
folder: co
---


---

.coで動作しているEC-CUBE本体のソースコードは、EC-CUBEリポジトリの co/master ブランチのソースです。
co/master ブランチを利用してEC-CUBEを起動し、 app/Customize ディレクトリでのカスタマイズを行います。

## ローカル環境のセットアップ手順

### ec-cube.coのレポジトリをclone

```
$ git clone <リポジトリURL> eccube-co-customize
$ cd eccube-co-customize
```

### 追従用のec-cubeレポジトリを追加

```
$ git remote add ec-cube https://github.com/EC-CUBE/ec-cube.git
$ git fetch ec-cube
```

### 開発用ローカルブランチ作成

```
$ git checkout -b develop origin/develop
```

### co/master に追従する

```
$ git merge --allow-unrelated-histories ec-cube/co/master
```

## テスト環境・本番環境への反映方法

ブランチを.coのリポジトリにpushすることでサイトへ反映が行われます。
反映されるまで1分程度かかります。

※ app/Customize以外のファイルをpushすることは可能ですが、サイトへ反映される対象は、Git管理機能の仕様を参照してください。

### テスト環境に反映

```
$ git push origin develop -u
```

### 本番環境に反映

```
$ git checkout master
$ git merge develop
$ git push origin master -u
```

## ローカル環境の立ち上げ

### ローカル環境の立ち上げ

```
$ docker-compose -f docker-compose.yml -f docker-compose.pgsql.yml -f docker-compose.dev.yml up
$ docker-compose exec -u www-data ec-cube bin/console eccube:install --no-interaction
$ docker-compose exec -u www-data ec-cube bin/console eccube:generate:proxies
$ docker-compose exec -u www-data ec-cube bin/console doctrine:schema:update --force --dump-sql
$ docker-compose exec -u www-data ec-cube bin/console doctrine:migrations:migrate
```

### ブラウザで表示

```
$ open http://127.0.0.1:8080/
```

## プラグインが適用されている環境の、ローカル環境への反映方法

プラグインが適用されている環境の場合、ローカル環境へは別途プラグインをインストールする必要があります。

### 認証キーの追加

```
$ docker exec <postgres container name> psql -U dbuser eccubedb -c "update dtb_base_info set authentication_key='<認証キー>' "
```

### プラグインのインストール・有効化

```
$ docker-compose exec -u www-data ec-cube bin/console eccube:composer:require ec-cube/<プラグインコード>
$ docker-compose exec -u www-data ec-cube bin/console eccube:plugin:enable --code=<プラグインコード>
```
56 changes: 56 additions & 0 deletions _pages/co/co_git.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
title: ec-cube.co Git管理機能の仕様
keywords: co ec-cube.co クラウド版 Git管理機能の仕様
tags: [co, ec-cube.co]
permalink: co/co_git
folder: co
---


---

スタンダードプランの場合のGit管理機能の仕様は以下になります。

| |Git管理対象 |管理画面<br>Plugin利用による影響 |管理画面からの操作 |
|-----------------------------------------------|-------------|----------------------------|----------------|
| \|\-\- app  | | | |
| \|&emsp;&emsp;\|\-\- Customize | o | | |
| \|&emsp;&emsp;\|&emsp;&emsp;\|\-\- Controller | o | | |
| \|&emsp;&emsp;\|&emsp;&emsp;\|-- Entity | o | | |
| \|&emsp;&emsp;\|&emsp;&emsp;`\-\- Resource | o | | |
| \|&emsp;&emsp;\|\-\- DoctrineMigrations | x | | |
| \|&emsp;&emsp;\|\-\- Plugin | x | o | |
| \|&emsp;&emsp;\|\-\- PluginData | x | o | |
| \|&emsp;&emsp;\|\-\- config | x | | |
| \|&emsp;&emsp;\|\-\- proxy | x | | |
| \|&emsp;&emsp;`\-\- template | o | o | o |
| \|&emsp;&emsp;&emsp;&emsp;\|\-\- admin | o | o | |
| \|&emsp;&emsp;&emsp;&emsp;\|\-\- default | o | o | o |
| \|&emsp;&emsp;&emsp;&emsp;`\-\- user_data | o | o | o |
| `\-\- html | | | |
|&emsp;&emsp;\|\-\- plugin      | o | o | |
|&emsp;&emsp;\|\-\- template      | o | o | o |
|&emsp;&emsp;\|&emsp;&emsp;\|\-\- admin | o | o | |
|&emsp;&emsp;\|&emsp;&emsp;`\-\- default | o | o | |
|&emsp;&emsp;\|\-\- upload       | x   | | |
|&emsp;&emsp;\|&emsp;&emsp;\|\-\- save_image | x | | o |
|&emsp;&emsp;\|&emsp;&emsp;`\-\- temp_image | x | | o |
|&emsp;&emsp;`\-\- user_data       | x | | o |
|&emsp;&emsp;&emsp;&emsp;`-- assets   | x | | o |

## 表の見方


1. デプロイ対象:gitの管理、ソースコードの反映が可能なリソース
1. Plugin利用による影響:<br>PluginのInstall/UnInstall/enable/disable/実行時の操作、などによりソースコードが書き換えられる可能性のあるリソース
1. 管理画面からの操作:管理画面でなんからの更新が行われるリソース(ページ/テンプレート管理など)

以下はEC-CUBE本体コードとしてのディレクトリであるため対象外

- DoctrineMigrations
- config
- proxy

「Plugin利用による影響」「管理画面からの操作」について

- gitからの反映以外の操作により生成・変更されたファイルもgit管理されます。
- その際、管理画面側の変更が正としてcommitされます。
17 changes: 17 additions & 0 deletions _pages/co/co_log.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: ec-cube.co ログの取得方法
keywords: co ec-cube.co クラウド版 ログの取得方法
tags: [co, ec-cube.co]
permalink: co/co_log
folder: co
---


---

## ログの取得方法

コンソール画面>ログから、ログの取得ができます。
WEBサーバーのエラーログとデータベースのエラーログが取得できます。

![co_log](/images/co/co_log.png)
21 changes: 21 additions & 0 deletions _pages/co/co_naming_rules.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: ec-cube.co ネーミングルール
keywords: co ec-cube.co クラウド版 ネーミングルール
tags: [co, ec-cube.co]
permalink: co/co_naming_rules
folder: co
---


---

※ [shopid]:申込みの際に指定したショップIDです(xxx.ec-cube.coのxxx部)。

| | | |
|-|-|-|
|リポジトリ名|eccube.co-[shopid]-customize||
|ブランチ|master->本番環境, develop->テスト環境|※ スタンダードプランのみ|
|namespace(本番環境)|[shopid]||
|namespace(テスト環境)|stg-[shopid]|※ スタンダードプランのみ|
|ショップURL(本番環境)|[shopid].ec-cuube.shop||
|ショップURL(テスト環境)|stg-[shopid].ec-cuube.shop|※ スタンダードプランのみ|
26 changes: 26 additions & 0 deletions _pages/co/co_staging.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: ec-cube.co テスト環境の構築
keywords: co ec-cube.co クラウド版 テスト環境の構築
tags: [co, ec-cube.co]
permalink: co/co_staging
folder: co
---


---

## テスト環境の構築

コンソール画面>テスト環境から、テスト環境の構築ができます。
テスト環境の項目から、テスト環境のショップURL、ログインページのアドレスを確認することができます。
ログインアカウントは、本番環境で使用しているものと同じになります。

![console_staging](/images/co/console_staging_01.png)

## 環境の複製

テスト環境の作成と削除から、現在の本番環境を複製します。
複製したときに過去のテスト環境がある場合、古いものが破棄されます。
作成日時は確認することができます。

![console_staging](/images/co/console_staging_02.png)
41 changes: 41 additions & 0 deletions _pages/co/co_update_guidelines.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: ec-cube.co アップデート指針
keywords: co ec-cube.co クラウド版 アップデート指針
tags: [co, ec-cube.co]
permalink: co/co_update_guidelines
folder: co
---


---

## 自動アップデート

ec-cube.coでは、EC-CUBEの自動アップデートが提供されます。

## 適用されるソースコード

ec-cube.coで利用されているEC-CUBEのソースコードは [co/masterブランチ](https://github.com/EC-CUBE/ec-cube/tree/co/master){:target="_blank"} で公開されています。
[4.0ブランチ](https://github.com/EC-CUBE/ec-cube/tree/4.0){:target="_blank"} のHEADが [co/masterブランチ](https://github.com/EC-CUBE/ec-cube/tree/co/master){:target="_blank"} に適宜マージされ、週次メンテナンスのタイミングで取り込まれます。

現在ec-cube.coに適用されているEC-CUBEのソースコードは、[co/YYYYMMDD](https://github.com/EC-CUBE/ec-cube/tags){:target="_blank"} をご確認ください。

## アップデート指針

EC-CUBEのPull Request取り込み基準と同様、互換性の保持を優先します。

Pull Request互換性保持チェックリスト

- 既存機能の仕様変更
- フックポイントの呼び出しタイミングの変更
- フックポイントのパラメータの削除・データ型の変更
- twigファイルに渡しているパラメータの削除・データ型の変更
- Serviceクラスの公開関数の、引数の削除・データ型の変更
- 入出力ファイル(CSVなど)のフォーマット変更

## 反映タイミング

週次メンテナンスのタイミングでアップデートが行われます。

- 週次メンテナンス(毎週木曜9:00〜10時、無停止でのメンテナンス):EC-CUBEのアップデートを実施
- 月次メンテナンス(毎月木曜9:00〜10時、停止を伴う場合がある):GKEノード等、インフラ・ミドルウェアの更新を実施
Binary file added images/co/co_log.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/co/console_staging_01.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/co/console_staging_02.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/co/console_standard.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.