From cc988d692d710e9c857296d1aa7d34c17e786a45 Mon Sep 17 00:00:00 2001 From: Stuart Clements Date: Mon, 21 Oct 2019 16:45:08 +0200 Subject: [PATCH] Converting parameter list to table --- docs/installation_guide.md | 135 +++++++++++++++++++++++++++++-------- 1 file changed, 106 insertions(+), 29 deletions(-) diff --git a/docs/installation_guide.md b/docs/installation_guide.md index 31a57ac38..100d3057b 100644 --- a/docs/installation_guide.md +++ b/docs/installation_guide.md @@ -94,35 +94,112 @@ The parameters are described below - note that at the very least, you will need ##### Required parameters -- **hostname**: The target host's hostname, which is used to access the Portal and the registry service. It should be the IP address or the fully qualified domain name (FQDN) of your target machine, e.g., `192.168.1.10` or `reg.yourdomain.com`. _Do NOT use `localhost` or `127.0.0.1` or `0.0.0.0` for the hostname - the registry service needs to be accessible by external clients!_ - -- **data_volume**: The location to store harbor's data. - -- **harbor_admin_password**: The administrator's initial password. This password only takes effect for the first time Harbor launches. After that, this setting is ignored and the administrator's password should be set in the Portal. _Note that the default username/password are **admin/Harbor12345** ._ - -- **database**: the configs related to local database - - **password**: The root password for the PostgreSQL database. Change this password for any production use. - - **max_idle_conns**: The maximum number of connections in the idle connection pool. If <=0 no idle connections are retained. The default value is 50 and if it is not configured the 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 100 for the max connections to the Harbor database. If it is not configured the value is 0. - -- **jobservice**: jobservice related service - - **max_job_workers**: The maximum number of replication workers in job service. For each image replication job, a worker synchronizes all tags of a repository to the remote destination. Increasing this number allows more concurrent replication jobs in the system. However, since each worker consumes a certain amount of network/CPU/IO resources, please carefully pick the value of this attribute based on the hardware resource of the host. -- **log**: log related url - - **level**: log level, options are debug, info, warning, error, fatal - - **local**: The default is to retain logs locally. - - **rotate_count**: Log files are rotated **rotate_count** times before being removed. If count is 0, old versions are removed rather than rotated. - - **rotate_size**: Log files are rotated only if they grow bigger than **rotate_size** bytes. If size is followed by k, the size is assumed to be in kilobytes. If the M is used, the size is in megabytes, and if G is used, the size is in gigabytes. So size 100, size 100k, size 100M and size 100G are all valid. - - **location**: the directory to store logs - - **external_endpoint**: Enable this option to forward logs to a syslog server. - - **protocol**: Transport protocol for the syslog server. Default is TCP. - - **host**: The URL of the syslog server. - - **port**: The port on which the syslog server listens. - -- **https**: The protocol used to access the Portal and the token/notification service. - - - **port**: port number for HTTPS - - **certificate**: The path to the SSL certificate. This is only applied when the protocol is set to HTTPS. - - **private_key**: The path to the SSL key. This is only applied when the protocol is set to HTTPS. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ Required Parameters for Harbor +
ParameterSub-parametersDescription and Additional Parameters
hostnameNoneThe target host’s hostname, which is used to access the Portal and the registry service. It should be the IP address or the fully qualified domain name (FQDN) of your target machine, e.g., 192.168.1.10 or reg.yourdomain.com. Do NOT use localhost or 127.0.0.1 or 0.0.0.0 for the hostname - the registry service needs to be accessible by external clients!
data_volumeNoneThe location to store harbor’s data.
harbor_admin_passwordNoneThe administrator’s initial password. This password only takes effect for the first time Harbor launches. After that, this setting is ignored and the administrator’s password should be set in the Portal. Note that the default username/password are admin/Harbor12345 .
database the configs related to local database
 passwordThe root password for the PostgreSQL database. Change this password for any production use.
 max_idle_connsThe maximum number of connections in the idle connection pool. If <=0 no idle connections are retained. The default value is 50 and if it is not configured the value is 2.
 max_open_connsThe maximum number of open connections to the database. If <= 0 there is no limit on the number of open connections. The default value is 100 for the max connections to the Harbor database. If it is not configured the value is 0.
jobservice jobservice related service
 max_job_workersThe maximum number of replication workers in job service. For each image replication job, a worker synchronizes all tags of a repository to the remote destination. Increasing this number allows more concurrent replication jobs in the system. However, since each worker consumes a certain amount of network/CPU/IO resources, please carefully pick the value of this attribute based on the hardware resource of the host.
log log related url
 levellog level, options are debug, info, warning, error, fatal
 localThe default is to retain logs locally.
    +
  • rotate_count: Log files are rotated rotate_count times before being removed. If count is 0, old versions are removed rather than rotated.
    • +
  • rotate_size: Log files are rotated only if they grow bigger than rotate_size bytes. If size is followed by k, the size is assumed to be in kilobytes. If the M is used, the size is in megabytes, and if G is used, the size is in gigabytes. So size 100, size 100k, size 100M and size 100G are all valid.
    • +
  • location: the directory to store logs
    • +
 external_endpointEnable this option to forward logs to a syslog server. +
    +
  • protocol: Transport protocol for the syslog server. Default is TCP.
    • +
  • host: The URL of the syslog server.
    • +
  • port: The port on which the syslog server listens
    • +
https 

The protocol used to access the Portal and the token/notification service.

+

IMPORTANT: Harbor does not ship with any certificates, and uses HTTP by default to serve registry requests. This is acceptable only in air-gapped test or development environments. In production environments, always use HTTPS. If you enable Content Trust with Notary, you must use HTTPS.

+

You can use certificates that are signed by a trusted third-party CA, or in you can use self-signed certificates. For information about how to create a CA, and how to use a CA to sign a server certificate and a client certificate, see Configuring Harbor with HTTPS Access.

 portport number for HTTPS
 certificateThe path to the SSL certificate. This is only applied when the protocol is set to HTTPS.
 private_keyThe path to the SSL key. This is only applied when the protocol is set to HTTPS.
**IMPORTANT**: Harbor does not ship with any certificates, and uses HTTP by default to serve registry requests. This is acceptable only in air-gapped test or development environments. In production environments, always use HTTPS. If you enable Content Trust with Notary, you must use HTTPS.