リファレンス

Updated 2 years ago by Admin

すべての構成パラメータの索引：

  • DRONE_CPU_PERIOD
    オプションの整数値。 CPUクォータと一緒に使用されるCPUCFSスケジューラ期間を指定します。
    DRONE_CPU_PERIOD=100000
  • DRONE_CPU_QUOTA
    オプションの整数値。すべてのパイプラインコンテナにCPUCFSクォータを課します。コンテナがスロットルされる前に制限されるCPU期間あたりのマイクロ秒数。
    DRONE_CPU_QUOTA=100
  • DRONE_CPU_SET
    オプションのコンマ区切りの文字列値。パイプラインコンテナが使用できる特定のCPUまたはコアを制限します。
    DRONE_CPU_SET=1,3
  • DRONE_CPU_SHARES
    オプションの整数値。このフラグをデフォルトの1024より大きい値または小さい値に設定して、パイプラインコンテナの重みを増減し、ホストマシンのCPUサイクルの大なり小なりの割合にアクセスできるようにします。
    DRONE_CPU_SHARES=1024
  • DRONE_DEBUG
    オプションのブール値。デバッグレベルのログを有効にします。
    DRONE_DEBUG=true
  • DRONE_DOCKER_CONFIG
    オプションの文字列値。サードパーティシステムからレジストリ認証情報を取得するために使用されるDockerconfig.jsonファイルへのパスを提供します。
    DRONE_DOCKER_CONFIG=/root/.docker/config.json
    通常、このファイルをホストマシンからDockerコンテナにマウントする必要があることに注意してください。上で定義した構成パスは、コンテナ内のファイルパスを指している必要があることに注意してください。
    docker run \
    --volume /root/.docker/config.json:/root/.docker/config.json
  • DRONE_DOCKER_STREAM_PULL
    オプションのブール値。 Dockerプルからの出力をビルドログに書き込むことを無効にします。この設定はデフォルトで有効になっています。
    DRONE_DOCKER_STREAM_PULL=true
  • DRONE_ENV_PLUGIN_ENDPOINT
    オプションの文字列値。外部環境変数プラグインにhttpリクエストを行うために使用されるエンドポイントを提供します。外部環境変数プラグインを使用して、サードパーティシステムからカスタムパイプライン環境変数を取得できます。
    DRONE_ENV_PLUGIN_ENDPOINT=http://1.2.3.4:3000
  • DRONE_ENV_PLUGIN_SKIP_VERIFY
    オプションのブール値。プラグインエンドポイントにhttpリクエストを行うときにSSL検証を無効にします。これは安全ではないため、お勧めしません。
    DRONE_ENV_PLUGIN_SKIP_VERIFY=false
  • DRONE_ENV_PLUGIN_TOKEN
    オプションの文字列値。プラグインエンドポイントへのhttpリクエストの認証に使用されるシークレットトークンを提供します。
    DRONE_ENV_PLUGIN_TOKEN=bea26a2221fd8090ea38720fc445eca6
  • DRONE_HTTP_BIND
    オプションの文字列値は、httpリスナーポートを構成します。デフォルト値は：3000です。この値をオーバーライドすることはお勧めしません。
    DRONE_HTTP_BIND=:3000
  • DRONE_HTTP_HOST
    httpリスナーのホスト名を構成するオプションの文字列値。デフォルト値は空の文字列です。この値を設定することはお勧めしません。
    DRONE_HTTP_HOST=runner.company.com:3000
  • DRONE_HTTP_PROTO
    オプションの文字列値は、httpリスナープロトコルを構成します。デフォルト値はhttpです。この値をオーバーライドすることはお勧めしません。
    DRONE_HTTP_PROTO=http
  • DRONE_LIMIT_EVENTS
    オプションのコンマ区切りの文字列値。このランナーが処理できるビルドイベントのホワイトリストを提供します。これにより、このランナーが処理できるワークロードの種類を制限するための追加のセキュリティレイヤーが提供されます。
    DRONE_LIMIT_EVENTS=push,tag
  • DRONE_LIMIT_REPOS
    オプションのコンマ区切りの文字列値。一致するリポジトリのみを処理するようにランナーを構成します。これにより、セキュリティがさらに強化され、信頼できないリポジトリがこのランナーでパイプラインを実行するのを防ぐことができます。
    DRONE_LIMIT_EVENTS=octocat/hello-world,spaceghost/*
  • DRONE_LIMIT_TRUSTED
    オプションのブール値。信頼できるリポジトリのみを処理するようにランナーを構成します。これにより、セキュリティがさらに強化され、信頼できないリポジトリがこのランナーでパイプラインを実行するのを防ぐことができます。
    DRONE_LIMIT_TRUSTED=true
  • DRONE_MEMORY_LIMIT
    オプションの整数値。単一のパイプラインコンテナが使用できるメモリの最大量。バイト単位で構成されます。
    DRONE_MEMORY_LIMIT=500000000
  • DRONE_MEMORY_SWAP_LIMIT
    オプションの整数値。単一のパイプラインコンテナがディスクにスワップできるメモリの最大量（バイト単位で構成）。
    DRONE_MEMORY_SWAP_LIMIT=500000000
  • DRONE_NETRC_CLONE_ONLY
    オプションのブール値。クローンステップにクローンクレデンシャルのみを挿入するようにランナーを構成します。
    リポジトリがプライベートであるか、クローン作成に認証が必要な場合、Droneはすべてのパイプラインステップにクローン資格情報を挿入することに注意してください。リポジトリが公開されている場合、Droneはパイプラインステップにクレデンシャルを挿入しません。
    DRONE_NETRC_CLONE_ONLY=true
  • DRONE_REGISTRY_PLUGIN_ENDPOINT
    オプションの文字列値。外部レジストリプラグインにhttpリクエストを行うために使用されるエンドポイントを提供します。外部レジストリプラグインを使用して、サードパーティシステムからレジストリクレデンシャルを取得できます。
    DRONE_REGISTRY_PLUGIN_ENDPOINT=http://1.2.3.4:3000
  • DRONE_REGISTRY_PLUGIN_SKIP_VERIFY
    オプションのブール値。レジストリプラグインエンドポイントにhttpリクエストを行うときにSSL検証を無効にします。これは安全ではないため、お勧めしません。
    DRONE_REGISTRY_PLUGIN_SKIP_VERIFY=false
  • DRONE_REGISTRY_PLUGIN_TOKEN
    オプションの文字列値。レジストリプラグインエンドポイントへのhttpリクエストの認証に使用されるトークンを提供します。
    DRONE_REGISTRY_PLUGIN_TOKEN=bea26a2221fd8090ea38720fc445eca6
  • DRONE_RPC_DUMP_HTTP
    オプションのブール値。デバッグ目的でhttp要求と応答をログにダンプできるようにします。これは、ランナーとサーバー間の接続の問題をデバッグしているときにのみ有効にする必要があります。
    DRONE_RPC_DUMP_HTTP=true
  • DRONE_RPC_DUMP_HTTP_BODY
    オプションのブール値。デバッグの目的で、http要求と応答の本文をログにダンプできるようにします。これは、ランナーとサーバー間の接続の問題をデバッグしているときにのみ有効にする必要があります。
    DRONE_RPC_DUMP_HTTP_BODY=true
  • DRONE_RPC_HOST
    必要な文字列値。Droneサーバへの接続に使用されるホスト名（およびオプションのポート）を定義します。
    DRONE_RPC_HOST=drone.company.com
  • DRONE_RPC_PROTO
    必要な文字列値。Droneサーバへの接続に使用されるプロトコルを定義します。値はhttpまたはhttpsのいずれかである必要があります。
    DRONE_RPC_PROTO=https
  • DRONE_RPC_SECRET
    必要な文字列値。Droneサーバがhttpリクエストを認証するために使用する共有シークレットを提供します。
    DRONE_RPC_SECRET=bea26a2221fd8090ea38720fc445eca6
  • DRONE_RPC_SKIP_VERIFY
    オプションのブール値。Droneサーバにhttpリクエストを行うときにSSL検証を無効にします。これは安全ではないため、お勧めしません。
    DRONE_RPC_SKIP_VERIFY=false
  • DRONE_RUNNER_CAPACITY
    オプションの数値。ランナーが実行できる同時パイプラインの数を制限します。ランナーは、デフォルトで2つの同時パイプラインを実行します。
    DRONE_RUNNER_CAPACITY=10
  • DRONE_RUNNER_CLONE_IMAGE
    オプションの文字列値。リポジトリのクローン作成に使用されるDockerイメージをオーバーライドします。
    DRONE_RUNNER_CLONE_IMAGE=drone/git:1
  • DRONE_RUNNER_DEVICES
    オプションのコンマ区切りリスト。すべてのパイプラインステップにマウントされているデバイスのリストを提供します。
    DRONE_RUNNER_DEVICES=/dev/sdb
  • DRONE_RUNNER_ENV_FILE
    オプションの文字列値。すべてのパイプラインステップに挿入されるグローバル環境変数を定義するために使用される環境変数ファイルへのパスを提供します。環境ファイルの形式については、こちらをご覧ください。
    DRONE_RUNNER_ENV_FILE=/etc/drone.conf
    このファイルをホストマシンからDockerコンテナにマウントすることを忘れないでください。上で定義した構成パスは、コンテナー内のファイルパスを指している必要があることに注意してください。
    docker run \
    --volume /etc/drone.conf:/etc/drone.conf
  • DRONE_RUNNER_ENVIRON
    オプションの文字列マップ。すべてのパイプラインステップに注入される一連のグローバル環境変数を提供します。
    DRONE_RUNNER_ENVIRON=foo:bar,baz:qux
  • DRONE_RUNNER_LABELS
    オプションの文字列マップ。パイプラインを特定のマシンまたはマシンのセットにルーティングするために使用されるラベルのセットを提供します。
    DRONE_RUNNER_LABELS=foo:bar,baz:qux
  • DRONE_RUNNER_MAX_PROCS
    オプションの数値。ランナーが単一のパイプラインに対して実行できる同時ステップの数を制限します。これはデフォルトで無効になっています。これは、リソースの枯渇を防ぐために並列ステップの最大数を調整する必要がある場合に役立ちます。
    DRONE_RUNNER_MAX_PROCS=10
  • DRONE_RUNNER_NAME
    オプションの文字列値。ランナーの名前を設定します。ランナー名はサーバに保存され、ビルドを特定のランナーまでさかのぼって追跡するために使用できます。
    DRONE_RUNNER_NAME=ec2-43-21.us-east-1.compute.amazonaws.com
  • DRONE_RUNNER_NETWORKS
    オプションのコンマ区切りリスト。すべてのパイプラインステップに接続されているDockerネットワークのリストを提供します。
    DRONE_RUNNER_NETWORKS=networkA,networkB
  • DRONE_RUNNER_PRIVILEGED_IMAGES
    オプションのコンマ区切りリスト。デフォルトで特権コンテナとして開始されるDockerイメージのリストを提供します。
    特権モードは、コンテナのルートアクセスをホストマシンに効果的に付与します。注意して使用してください。
    DRONE_RUNNER_PRIVILEGED_IMAGES=plugins/docker,plugin/ecr
  • DRONE_RUNNER_SECRETS
    オプションの文字列マップ。すべてのパイプラインで使用できる一連のグローバルな名前付きシークレットを提供します。
    DRONE_RUNNER_SECRETS=username:bar,password:qux
  • DRONE_RUNNER_VOLUMES
    オプションのコンマ区切りリスト。すべてのパイプラインステップにマウントされるDockerボリュームのリストを提供します。
    DRONE_RUNNER_VOLUMES=/path/on/host:/path/in/container
    上記の例では、コロンの左側のパスがホストマシンのパスです。右側のパスは、パイプラインコンテナ内のパスです。
  • DRONE_SECRET_PLUGIN_ENDPOINT
    オプションの文字列値。外部シークレットプラグインにhttpリクエストを行うために使用されるエンドポイントを提供します。外部シークレットプラグイン（ボールトなど）を使用して、サードパーティシステムからシークレットを取得できます。
    DRONE_SECRET_PLUGIN_ENDPOINT=http://1.2.3.4:3000
  • DRONE_SECRET_PLUGIN_SKIP_VERIFY
    オプションのブール値。プラグインエンドポイントにhttpリクエストを行うときにSSL検証を無効にします。これは安全ではないため、お勧めしません。
    DRONE_SECRET_PLUGIN_SKIP_VERIFY=false
  • DRONE_SECRET_PLUGIN_TOKEN
    オプションの文字列値。プラグインエンドポイントへのhttpリクエストの認証に使用されるシークレットトークンを提供します。
    DRONE_SECRET_PLUGIN_TOKEN=bea26a2221fd8090ea38720fc445eca6
  • DRONE_TMATE_ENABLED
    オプションのブール値。tmateを使用してパイプラインコンテナへのリモートsshアクセスを有効にします。ホスト型サービスとセルフホスト型サービスの両方がサポートされています。この機能はデフォルトで無効になっています。この機能には、docker runnerのバージョン1.6.1以降が必要です。
    DRONE_TMATE_ENABLED=true
    以下の構成パラメータを使用して、セルフホストのtmateサーバを構成することもできることに注意してください。 tmateサーバのセルフホスティングの詳細については、公式のtmateドキュメントをご覧ください。
    DRONE_TMATE_ENABLED=true
    DRONE_TMATE_HOST=tmate.company.com
    DRONE_TMATE_PORT=2200
    DRONE_TMATE_FINGERPRINT_RSA=SHA256:iL3StSCmPU+7p2IoD8y0huMXRVFIZyGFZa8r+lO3U5I
    DRONE_TMATE_FINGERPRINT_ED25519=SHA256:gXLaN8IUxUMmlm/xu7M2NEFMlbUr5UORUgMi86Kh+tI
  • DRONE_TRACE
    オプションのブール値。トレースレベルのログを有効にします。
    DRONE_TRACE=true
  • DRONE_UI_DISABLED
    オプションのブール値。ランナーのユーザーインターフェースを無効にします。
    DRONE_UI_DISABLE=true
  • DRONE_UI_PASSWORD
    オプションの文字列値。ウェブダッシュボードの認証とアクセスに使用される基本認証パスワードを設定します。パスワードが指定されていない場合、Webダッシュボードは無効になります。
    DRONE_UI_PASSWORD=root
  • DRONE_UI_REALM
    オプションの文字列値。ウェブダッシュボードの認証とアクセスに使用される基本認証レルムを設定します。
    DRONE_UI_REALM=DroneRealm
  • DRONE_UI_USERNAME
    オプションの文字列値。ウェブダッシュボードの認証とアクセスに使用される基本認証ユーザー名を設定します。
    DRONE_UI_USERNAME=root

How did we do?