Setup TOP Environments/Settings

開発者

このページは、K2HR3 システムの変更・機能追加するための情報を説明しています。

レポジトリの構成

ここでは、githubのk2hr3レポジトリについて説明しています。

k2hr3レポジトリは、次のサブモジュールから構成されています。

後段では、各レポジトリについて説明しています。

k2hr3_apiレポジトリ

この章では、k2hr3_apiレポジトリの内容とソースコードのビルド&テスト方法を説明しています。

k2hr3_apiレポジトリは、APIサーバー用レポジトリです。

  1. Github上で https://github.com/yahoojapan/k2hr3_apiをforkします

  2. レポジトリをcloneします

     $ git clone https://github.com/YOUR-USERNAME/k2hr3_api.git
    
  3. ローカル環境に必要なパッケージをインストールします。 パッケージのビルドには、k2hdkc のライブラリとヘッダファイルが必要となります。

    Debian(Stretch) / Ubuntu(Bionic Beaver)をお使いの場合は次のように実行してください。

     $ sudo apt-get update -y
     $ sudo apt-get install curl -y
     $ curl -s https://packagecloud.io/install/repositories/antpickax/stable/script.deb.sh | sudo bash
     $ sudo apt-get install k2hdkc-dev
    

    CentOSでビルドする場合には、SoftwareCollectionsからdevtoolsetパッケージをインストールしてください。やり方は次のとおりです。

     $ sudo yum install centos-release-scl
     $ sudo yum install devtoolset-7
     $ scl enable devtoolset-7 bash
    

    Fedora28 / CentOS7.xをお使いの場合は次のように実行してください。

     $ sudo yum makecache
     $ sudo yum install curl -y
     $ curl -s https://packagecloud.io/install/repositories/antpickax/stable/script.rpm.sh | sudo bash
     $ sudo yum install k2hdkc-devel
    

    それ以外のOSをお使いの場合は、K2HDKCのソースコードをビルドしてインストールしてください。ビルド方法は、こちらを見てください。

    k2hdkc のライブラリとヘッダファイルのインストールが終わったら、npmパッケージをインストールします。

     $ cd k2hr3_api/
     $ npm install
    
  4. ブランチを作り、必要でしたら、コード変更して見てください
     $ git checkout -b my-first-contribution
    
  5. コードの書式チェックとプログラムのテストをします
     $ npm run test
    
  6. コード変更があれば、commitして、push します
     $ git add .
     $ git commit -m "Short description of your changes."
     $ git push origin my-first-contribution
    
  7. コード変更があれば、ぜひプルリクエストを投げてみてください!

k2hr3_appレポジトリ

この章では、k2hr3_appレポジトリの内容とソースコードのビルド&テスト方法を説明しています。

k2hr3_appレポジトリは、APPサーバ用レポジトリです。

  1. Github上で https://github.com/yahoojapan/k2hr3_appをforkします

  2. レポジトリをcloneします

     $ git clone https://github.com/YOUR-USERNAME/k2hr3_app.git
    
  3. ローカル環境に必要なパッケージをインストールします

     $ cd k2hr3_app/
     $ npm install
    
  4. ブランチを作り、必要でしたら、コード変更して見てください

     $ git checkout -b my-first-contribution
    
  5. コードの書式チェックとプログラムのテストをします

     $ npm run build
     $ npm run test
    
  6. コード変更があれば、commitして、push します

     $ git add .
     $ git commit -m "Short description of your changes."
     $ git push origin my-first-contribution
    
  7. コード変更があれば、ぜひプルリクエストを投げてみてください!

k2hr3_osnlレポジトリ

この章では、k2hr3_osnlレポジトリの内容とソースコードのビルド&テスト方法を説明しています。

k2hr3_osnlレポジトリは、OpenStack通知リスナー用のレポジトリです。

  1. Github上で https://github.com/yahoojapan/k2hr3_osnlをforkします

  2. レポジトリをcloneします

     $ git clone https://github.com/YOUR-USERNAME/k2hr3_osnl.git
    
  3. ローカル環境に必要なパッケージをインストールします

     $ cd k2hr3_osnl/
     $ pip3 install pipenv
     $ python3 -m pipenv install -dev --python /path/to/python3
     $ pipenv shell
    
  4. ブランチを作り、必要でしたら、コード変更して見てください

     (k2hr3_osnl) $ git checkout -b my-first-contribution
    
  5. コードの書式チェックとプログラムのテストをします

     (k2hr3_osnl) $ make lint test
    
  6. コード変更があれば、commitして、push します

     (k2hr3_osnl) $ git add .
     (k2hr3_osnl) $ git commit -m "Short description of your changes."
     (k2hr3_osnl) $ git push origin my-first-contribution
    
  7. コード変更があれば、ぜひプルリクエストを投げてみてください!

k2hr3_utilsレポジトリ

この章では、k2hr3_utilsレポジトリの内容とソースコードのビルド&テスト方法を説明しています。

このレポジトリは、運用/開発ツールなど各種ツール用のレポジトリです。ここでは、devclusterを例にして説明します。

  1. Github上で https://github.com/yahoojapan/k2hr3_utilsをforkします

  2. レポジトリをcloneします

     $ git clone https://github.com/YOUR-USERNAME/k2hr3_utils.git
    
  3. ブランチを作ります。必要でしたら、コード変更して見てください

     $ cd k2hr3_utils/devcluster
     $ git checkout -b my-first-contribution
    
  4. cluster.shをデバッグモードで起動して、自分の環境にエラーなしでデプロイできることを確認します。

     $ sh cluster.sh -d
    
  5. コード変更があれば、commitして、push します

     (k2hr3_osnl) $ git add .
     (k2hr3_osnl) $ git commit -m "Short description of your changes."
     (k2hr3_osnl) $ git push origin my-first-contribution
    
  6. コード変更があれば、ぜひプルリクエストを投げてみてください!

Setup TOP Environments/Settings