Upstream/harbor
1
0
Fork 0
mirror of https://github.com/goharbor/harbor.git synced 2025-02-27 17:21:58 +01:00
Code Issues Projects Releases Wiki Activity

Converted optional params into a table

Browse Source
This commit is contained in:
Stuart Clements 2019-10-21 17:50:40 +02:00
parent 6a7ae42c09
commit 6f10ac9c78
1 changed files with 173 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

232
docs/installation_guide.md
View File

@ -206,68 +206,182 @@ You can use certificates that are signed by a trusted third-party CA, or you can
### Optional parameters ### Optional parameters
- **http**: Do not use HTTP in production environments. Using HTTP is acceptable only in air-gapped test or development environments that do not have a connection to the external internet. Using HTTP in environments that are not air-gapped exposes you to man-in-the-middle attacks. <table width="100%" border="0">
- **port** : Port number for HTTP <caption>
Optional Parameters for Harbor
- **external_url**: Enable it if use external proxy, and when it enabled the hostname will no longer used </caption>
<tr>
- **clair**: Clair related configs <th scope="col">Parameter</th>
- **updaters_interval**: The interval of clair updaters, the unit is hour, set to 0 to disable the updaters <th scope="col">Sub-Parameters</th>
- **http_proxy**: Config http proxy for Clair, e.g. `http://my.proxy.com:3128`. <th scope="col">Description and Additional Parameters </th>
- **https_proxy**: Config https proxy for Clair, e.g. `http://my.proxy.com:3128`. </tr>
- **no_proxy**: Config no proxy for Clair, e.g. `127.0.0.1,localhost,core,registry`. <tr>
<td valign="top"><code>http</code></td>
- **chart**: chart related configs <td valign="top">&nbsp;</td>
- **absolute_url**: if set to enabled chart will use absolute url, otherwise set it to disabled, chart will use relative url. <td valign="top">Do not use HTTP in production environments. Using HTTP is acceptable only in air-gapped test or development environments that do not have a connection to the external internet. Using HTTP in environments that are not air-gapped exposes you to man-in-the-middle attacks.</td>
</tr>
- **external_database**: external database configs, Currently only support POSTGRES. <tr>
- **harbor**: harbor's core database configs <td valign="top">&nbsp;</td>
- **host**: hostname for harbor core database <td valign="top"><code>port</code></td>
- **port**: port of harbor's core database <td valign="top">Port number for HTTP</td>
- **db_name**: database name of harbor core database </tr>
- **username**: username to connect harbor core database <tr>
- **password**: password to harbor core database <td valign="top"><code>external_url</code></td>
- **ssl_mode**: is enable ssl mode <td valign="top">None</td>
- **max_idle_conns**: The maximum number of connections in the idle connection pool. If <=0 no idle connections are retained. The default value is 2. <td valign="top">Enable it if use external proxy, and when it enabled the hostname will no longer used</td>
- **max_open_conns**: The maximum number of open connections to the database. If <= 0 there is no limit on the number of open connections. The default value is 0. </tr>
- **clair**: clair's database configs <tr>
- **host**: hostname for clair database <td valign="top"><code>clair</code></td>
- **port**: port of clair database <td valign="top">&nbsp;</td>
- **db_name**: database name of clair database <td valign="top">Clair related configs</td>
- **username**: username to connect clair database </tr>
- **password**: password to clair database <tr>
- **ssl_mode**: is enable ssl mode <td valign="top">&nbsp;</td>
- **notary_signer**: notary's signer database configs <td valign="top"><code>updaters_interval</code></td>
- **host**: hostname for notary signer database <td valign="top">The interval of clair updaters, the unit is hour, set to 0 to disable the updaters</td>
- **port**: port of notary signer database </tr>
- **db_name**: database name of notary signer database <tr>
- **username**: username to connect notary signer database <td valign="top">&nbsp;</td>
- **password**: password to notary signer database <td valign="top"><code>http_proxy</code></td>
- **ssl_mode**: is enable ssl mode <td valign="top">Config http proxy for Clair, e.g. <code>http://my.proxy.com:3128</code>.</td>
- **notary_server**: </tr>
- **host**: hostname for notary server database <tr>
- **port**: port of notary server database <td valign="top">&nbsp;</td>
- **db_name**: database name of notary server database <td valign="top"><code>https_proxy</code></td>
- **username**: username to connect notary server database <td valign="top">Config https proxy for Clair, e.g. <code>http://my.proxy.com:3128</code>.</td>
- **password**: password to notary server database </tr>
- **ssl_mode**: is enable ssl mode <tr>
<td valign="top">&nbsp;</td>
- **external_redis**: configs for use the external redis <td valign="top"><code>no_proxy</code></td>
- **host**: host for external redis <td valign="top">Config no proxy for Clair, e.g. <code>127.0.0.1,localhost,core,registry</code>.</td>
- **port**: port for external redis </tr>
- **password**: password to connect external host <tr>
- **registry_db_index**: db index for registry use <td valign="top"><code>chart</code></td>
- **jobservice_db_index**: db index for jobservice <td valign="top">&nbsp;</td>
- **chartmuseum_db_index**: db index for chartmuseum <td valign="top">chart related configs</td>
</tr>
<tr>
<td valign="top">&nbsp;</td>
<td valign="top"><code>absolute_url</code></td>
<td valign="top">if set to enabled chart will use absolute url, otherwise set it to disabled, chart will use relative url.</td>
</tr>
<tr>
<td valign="top"><code>external_database</code></td>
<td valign="top">&nbsp;</td>
<td valign="top">external database configs, Currently only support POSTGRES.</td>
</tr>
<tr>
<td valign="top">&nbsp;</td>
<td valign="top"><code>harbor</code></td>
<td valign="top"><p>harbor&rsquo;s core database configs</p>
<ul>
<li><code>host</code>: hostname for harbor core database</li>
<li><code>port</code>: port of harbor&rsquo;s core database</li>
<li><code>db_name</code>: database name of harbor core database</li>
<li><code>username</code>: username to connect harbor core database</li>
<li><code>password</code>: password to harbor core database</li>
<li><code>ssl_mode</code>: is enable ssl mode</li>
<li><code>max_idle_conns</code>: The maximum number of connections in the idle connection pool. If &lt;=0 no idle connections are retained. The default value is 2.</li>
<li><code>max_open_conns</code>: The maximum number of open connections to the database. If &lt;= 0 there is no limit on the number of open connections. The default value is 0.</li>
</ul> </td>
</tr>
<tr>
<td valign="top">&nbsp;</td>
<td valign="top"><code>clair</code></td>
<td valign="top">clair&rsquo;s database configs
<ul>
<li><code>host</code>: hostname for clair database</li>
<li><code>port</code>: port of clair database</li>
<li><code>db_name</code>: database name of clair database</li>
<li><code>username</code>: username to connect clair database</li>
<li><code>password</code>: password to clair database</li>
<li><code>ssl_mode</code>: is enable ssl mode</li>
</ul> </td>
</tr>
<tr>
<td valign="top">&nbsp;</td>
<td valign="top"><code>notary_signer</code></td>
<td valign="top">notary&rsquo;s signer database configs
<ul>
<li><code>host</code>: hostname for notary signer database</li>
<li><code>port</code>: port of notary signer database</li>
<li><code>db_name</code>: database name of notary signer database</li>
<li><code>username</code>: username to connect notary signer database</li>
<li><code>password</code>: password to notary signer database</li>
<li><code>ssl_mode</code>: is enable ssl mode</li>
</ul> </td>
</tr>
<tr>
<td valign="top">&nbsp;</td>
<td valign="top"><code>notary_server</code></td>
<td valign="top"><ul>
<li><code>host</code>: hostname for notary server database</li>
<li><code>port</code>: port of notary server database</li>
<li><code>db_name</code>: database name of notary server database</li>
<li><code>username</code>: username to connect notary server database</li>
<li><code>password</code>: password to notary server database</li>
<li><code>ssl_mode</code>: is enable ssl mode</li>
</ul> </td>
</tr>
<tr>
<td valign="top"><code>external_redis</code></td>
<td valign="top">&nbsp;</td>
<td valign="top">configs for use the external redis</td>
</tr>
<tr>
<td valign="top">&nbsp;</td>
<td valign="top"><code>host</code></td>
<td valign="top">host for external redis</td>
</tr>
<tr>
<td valign="top">&nbsp;</td>
<td valign="top"><code>port</code></td>
<td valign="top">port for external redis</td>
</tr>
<tr>
<td valign="top">&nbsp;</td>
<td valign="top"><code>password</code></td>
<td valign="top">password to connect external host</td>
</tr>
<tr>
<td valign="top">&nbsp;</td>
<td valign="top"><code>registry_db_index</code></td>
<td valign="top">db index for registry use</td>
</tr>
<tr>
<td valign="top">&nbsp;</td>
<td valign="top"><code>jobservice_db_index</code></td>
<td valign="top">db index for jobservice</td>
</tr>
<tr>
<td valign="top">&nbsp;</td>
<td valign="top"><code>chartmuseum_db_index</code></td>
<td valign="top">db index for chartmuseum </td>
</tr>
<tr>
<td valign="top"><code>storage_service</code></td>
<td valign="top">&nbsp;</td>
<td valign="top">By default, Harbor stores images and chart on your local filesystem. In a production environment, you may consider use other storage backend instead of the local filesystem, like S3, OpenStack Swift, Ceph, etc. These parameters are configurations for registry. </td>
</tr>
<tr>
<td valign="top">&nbsp;</td>
<td valign="top"><code>ca_bundle</code></td>
<td valign="top">The path to the custom root ca certificate, which will be injected into the trust store of registry's and chart repository's containers. This is usually needed when the user hosts a internal storage with self signed certificate.</td>
</tr>
<tr>
<td valign="top">&nbsp;</td>
<td valign="top"><code>provider_name</code></td>
<td valign="top">Storage configs for registry, default is filesystem. for more info about this configuration please refer&nbsp;<a href="https://docs.docker.com/registry/configuration/" rel="nofollow">https://docs.docker.com/registry/configuration/</a></td>
</tr>
<tr>
<td valign="top">&nbsp;</td>
<td valign="top"><code>redirect</code></td>
<td valign="top"><code>disable</code>: set disable to true when you want to disable registry redirect</td>
</tr>
</table>
#### Configuring storage backend (optional) #### Configuring storage backend (optional)
- **storage_service**: By default, Harbor stores images and chart on your local filesystem. In a production environment, you may consider use other storage backend instead of the local filesystem, like S3, OpenStack Swift, Ceph, etc. These parameters are configurations for registry.
- **ca_bundle**: The path to the custom root ca certificate, which will be injected into the trust store of registry's and chart repository's containers. This is usually needed when the user hosts a internal storage with self signed certificate.
- **provider_name**: Storage configs for registry, default is filesystem. for more info about this configuration please refer https://docs.docker.com/registry/configuration/
- **redirect**:
- **disable**: set disable to true when you want to disable registry redirect
For example, if you use Openstack Swift as your storage backend, the parameters may look like this: For example, if you use Openstack Swift as your storage backend, the parameters may look like this:
``` yaml ``` yaml