From 6ba928ef9d61f6e453c86d954df3ef6535e05b2f Mon Sep 17 00:00:00 2001 From: Stuart Clements Date: Mon, 21 Oct 2019 20:17:11 +0200 Subject: [PATCH] Rewriting the optional options --- docs/installation_guide.md | 62 ++++++++++++++++++++------------------ 1 file changed, 32 insertions(+), 30 deletions(-) diff --git a/docs/installation_guide.md b/docs/installation_guide.md index 4c7f2bc31..d8e6ebeea 100644 --- a/docs/installation_guide.md +++ b/docs/installation_guide.md @@ -203,6 +203,8 @@ You can use certificates that are signed by a trusted third-party CA, or you can ### Optional parameters +The following table lists the additional parameters that you can set to configure your Harbor deployment beyond the required settings. In most cases, you need to uncomment the parameters in `harbor.yml`. + - + - + - + - + - + - + - + - + - + - @@ -285,27 +287,27 @@ You can use certificates that are signed by a trusted third-party CA, or you can - -
Optional Parameters for Harbor @@ -225,59 +227,59 @@ You can use certificates that are signed by a trusted third-party CA, or you can
external_url NoneEnable it if use external proxy, and when it enabled the hostname will no longer usedEnable this option to use an external proxy. When enabled, the hostname is no longer used.
clair  Clair related configsConfigure clair.
  updaters_intervalThe interval of clair updaters, the unit is hour, set to 0 to disable the updatersSet an interval for Clair updates, in hours. Set to 0 to disable the updates.
  http_proxyConfig http proxy for Clair, e.g. http://my.proxy.com:3128.Configure an HTTP proxy for Clair, for example, http://my.proxy.com:3128.
  https_proxyConfig https proxy for Clair, e.g. http://my.proxy.com:3128.Configure an HTTPS proxy for Clair, for example, http://my.proxy.com:3128.
  no_proxyConfig no proxy for Clair, e.g. 127.0.0.1,localhost,core,registry.Configure when not to use a proxy for Clair, for example, 127.0.0.1,localhost,core,registry.
chart  chart related configsConfigure Chart settings.
  absolute_urlif set to enabled chart will use absolute url, otherwise set it to disabled, chart will use relative url.Set to enabled for chart to use an absolute URL. Set to disabled for chart to use a relative URL.
external_database  external database configs, Currently only support POSTGRES.Configure external database settings, if you disable the local database option. Harbor currently only supports POSTGRES.
  harbor

harbor’s core database configs

+

Configure an external database for Harbor data.

    -
  • host: hostname for harbor core database
    • -
  • port: port of harbor’s core database
    • -
  • db_name: database name of harbor core database
    • -
  • username: username to connect harbor core database
    • -
  • password: password to harbor core database
    • -
  • ssl_mode: is enable ssl mode
    • +
  • host: Hostname of the Harbor database.
    • +
  • port: Database port.
    • +
  • db_name: Database name.
    • +
  • username: Username to connect to the core Harbor database.
    • +
  • password: Password for the account you set in username.
    • +
  • ssl_mode: Enable SSL mode.
  • 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.
  • 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.
  clairclair’s database configs + Configure an external database for Clair.
    -
  • host: hostname for clair database
    • -
  • port: port of clair database
    • -
  • db_name: database name of clair database
    • -
  • username: username to connect clair database
    • -
  • password: password to clair database
    • -
  • ssl_mode: is enable ssl mode
    • +
  • host: Hostname of the Clair database
    • +
  • port: Database port.
    • +
  • db_name: Database name.
    • +
  • username: Username to connect to the Clair database.
    • +
  • password: Password for the account you set in username.
    • +
  • ssl_mode: Enable SSL mode.
  notary_signernotary’s signer database configs + Configure an external database for the Notary signer database
    -
  • host: hostname for notary signer database
    • -
  • port: port of notary signer database
    • -
  • db_name: database name of notary signer database
    • -
  • username: username to connect notary signer database
    • -
  • password: password to notary signer database
    • -
  • ssl_mode: is enable ssl mode
    • +
  • host: Hostname of the Notary signer database
    • +
  • port: Database port.
    • +
  • db_name: Database name.
    • +
  • username: Username to connect to the Notary signer database.
    • +
  • password: Password for the account you set in username.
    • +
  • ssl_mode: Enable SSL mode.