SourceCommit の手動バックアップ

Classic/VPC環境で利用できます。

SourceCommitのリポジトリは、ユーザーソースコードを安全に保存して復旧できるように構成されています。しかし、ユーザーが誤ってリポジトリを削除すると、コードも削除されて復旧できません。このような状況に備え、SourceCommitを NAVERクラウドプラットフォームの他のサービスと連携して安全にコードをバックアップできます。

Cloud Functionsを通じたバックアップ

NAVERクラウドプラットフォームの Cloud Functionsと連携してコードをバックアップする方法を説明します。

1. バックアップする SourceBuild作成

最初に SourceCommitリポジトリをバックアップする SourceBuildプロジェクトを作成します。方法は次の通りです。

1. NAVERクラウドプラットフォームコンソールにアクセスします。
2. SourceCommitをバックアップする SourceBuildプロジェクトを作成するため、 Services > Developer Tools > SourceBuild メニューを順にクリックします。
3. SourceBuild画面で [+ビルドプロジェクト作成] ボタンをクリックします。
4. ビルド対象としてバックアップが必要な SourceCommitリポジトリを選択します。
5. SourceBuildで管理する ubuntuイメージをビルド環境に選択します。
   
6. 必要に応じてビルドコマンドを設定します。
7. 結果アップロード設定 のビルド結果 で結果保存 をクリックして選択します。

• 全体パスを入力してリポジトリをバックアップするように設定します。
  

8. ビルドプロジェクトの作成を完了します。

2. SourceCommit Webhook作成

SourceCommit Webhookを作成します。方法は次の通りです。

1. バックアップが必要な SourceCommitリポジトリで Hooks をクリックします。
2. 新しいウェブフックを作成するには [作成] ボタンをクリックします。シナリオに適したイベントタイプと Cloud Functionsを対象タイプに選択します。
   
3. [トリガー作成] ボタンをクリックしてトリガーとアクションを作成します。イベント発生時にビルドプロジェクトを開始するアクション例は、次の通りです。

const axios = require('axios');
const CryptoJS = require('crypto-js');

// Signature is the value of `x-ncp-apigw-signature-v2` field in the header.
function makeSignature(url, timestamp, accessKey, secretKey) {
  const space = ' ',
    newLine = '\n',
    method = 'POST';

  const hmac = CryptoJS.algo.HMAC.create(CryptoJS.algo.SHA256, secretKey);

  hmac.update(method);
  hmac.update(space);
  hmac.update(url);
  hmac.update(newLine);
  hmac.update(timestamp);
  hmac.update(newLine);
  hmac.update(accessKey);
  const hash = hmac.finalize();

  return hash.toString(CryptoJS.enc.Base64);
}

// Header is required for authentication to call NAVER Cloud Platform API.
function makeHeader(timestamp, accessKey, signKey) {
  const headers = {
    'Content-Type': 'application/json; charset=utf-8',
    'x-ncp-apigw-timestamp': timestamp,
    'x-ncp-iam-access-key': accessKey,
    'x-ncp-apigw-signature-v2': signKey,
  };

  return headers;
}

/**
 * Action to start(or stop) server(VPC) instances using Server API
 *
 * Input parameters that must be defined as action parameters
 * @params {string} accessKey: NAVER Cloud Platform account access key used for API authentication
 * @params {string} secretKey: NAVER Cloud Platform account secret key used for API authentication
 * @params {string} baseUrl: https://sourcebuild.apigw.ntruss.com
 * @params {string} apiUrl: `/api/v1/project/{projectId}/build`
 *
 * Please refer to the Server API guide for the accurate `baseUrl` and `apiUrl`.
 */

function startBuildProject(params) {
  let apiUrlWithParams = params.apiUrl;
  const url = `${params.baseUrl}${apiUrlWithParams}`;
  const timestamp = new Date().getTime().toString();
  const signKey = makeSignature(apiUrlWithParams, timestamp, params.accessKey, params.secretKey);
  const headers = makeHeader(timestamp, params.accessKey, signKey);

  return new Promise((resolve, reject) => {
    axios
      .post(url, {}, { headers: headers }) 
      .then(() => resolve({ done: true }))
      .catch((error) => reject({ done: false, errorMessage: error.response ? error.response.data.message : error.message }));
  });
}

exports.main = startBuildProject;

4. ウェブフックを作成した後、プッシュイベントを発生させて動作を確認します。

SourcePipelineを通じたバックアップ

NAVERクラウドプラットフォームの SourcePipelineで提供するトリガー機能を利用して SourceCommitリポジトリをバックアップする SourceBuildプロジェクトを実行できます。

1. バックアップする SourceBuild作成

最初に SourceCommitリポジトリをバックアップする SourceBuildプロジェクトを作成します。方法は次の通りです。

1. NAVERクラウドプラットフォームコンソールにアクセスします。
2. SourceCommitをバックアップする SourceBuildプロジェクトを作成するため、 Services > Developer Tools > SourceBuild メニューを順にクリックします。
3. SourceBuild画面で [+ビルドプロジェクト作成] ボタンをクリックします。
4. ビルド対象としてバックアップが必要な SourceCommitリポジトリを選択します。
5. SourceBuildで管理する ubuntuイメージをビルド環境に選択します。
   
6. 必要に応じてビルドコマンドを設定します。
7. 結果アップロード設定 のビルド結果 で結果保存 をクリックして選択します。

• 全体パスを入力してリポジトリをバックアップするように設定します。
  

8. ビルドプロジェクトの作成を完了します。

2. バックアップする SourcePipeline作成

SourceCommitで Pushが発生する時、パイプラインが動作して SourceBuildが動作できるように SourcePipelineを作成します。SourcePipelineを通じてユーザーはリポジトリに Pushイベントが発生する度に自動で SourceBuildを実行するように構成できます。この過程でリポジトリのバックアップを自動実行します。方法は次の通りです。

1. NAVERクラウドプラットフォームコンソールにアクセスします。
2. Services > Developer Tools > SourcePipeline メニューを順にクリックします。
3. SourcePipeline画面で [+パイプライン作成] ボタンをクリックします。
4. パイプラインの名前を設定します。
5. [タスク追加] ボタンをクリックして作成した SourceBuildプロジェクトを追加します。

• プロジェクトを追加する時、関連付け情報が正しいか確認します。
  

6. 追加したタスクの [+] ボタンをクリックして先行タスクがあいパイプラインを構成します。
   
7. Trigger設定 で Push をクリックして選択し、リポジトリを設定します。
   
8. パイプラインの作成を完了します。