mirror of
https://github.com/goharbor/harbor.git
synced 2024-11-22 18:25:56 +01:00
Merge pull request #5982 from SDBrett/docs
Documentation typo correction
This commit is contained in:
commit
fb28b11301
@ -39,9 +39,9 @@ Edit the file **make/harbor.cfg** and make necessary configuration changes such
|
||||
|
||||
You can compile the code by one of the three approaches:
|
||||
|
||||
#### I. Build with offical Golang image
|
||||
#### I. Build with official Golang image
|
||||
|
||||
* Get offcial Golang image from docker hub:
|
||||
* Get official Golang image from docker hub:
|
||||
|
||||
```sh
|
||||
$ docker pull golang:1.9.2
|
||||
|
@ -18,16 +18,16 @@ Harbor is deployed as several Docker containers, and, therefore, can be deployed
|
||||
### Hardware
|
||||
|Resource|Capacity|Description|
|
||||
|---|---|---|
|
||||
|CPU|minimal 2 CPU|4 CPU is prefered|
|
||||
|Mem|minimal 4GB|8GB is prefered|
|
||||
|Disk|minimal 40GB|160GB is prefered|
|
||||
|CPU|minimal 2 CPU|4 CPU is preferred|
|
||||
|Mem|minimal 4GB|8GB is preferred|
|
||||
|Disk|minimal 40GB|160GB is preferred|
|
||||
### Software
|
||||
|Software|Version|Description|
|
||||
|---|---|---|
|
||||
|Python|version 2.7 or higher|Note that you may have to install Python on Linux distributions (Gentoo, Arch) that do not come with a Python interpreter installed by default|
|
||||
|Docker engine|version 1.10 or higher|For installation instructions, please refer to: https://docs.docker.com/engine/installation/|
|
||||
|Docker Compose|version 1.6.0 or higher|For installation instructions, please refer to: https://docs.docker.com/compose/install/|
|
||||
|Openssl|latest is prefered|Generate certificate and keys for Harbor|
|
||||
|Openssl|latest is preferred|Generate certificate and keys for Harbor|
|
||||
### Network ports
|
||||
|Port|Protocol|Description|
|
||||
|---|---|---|
|
||||
@ -327,7 +327,7 @@ proxy:
|
||||
hostname = 192.168.0.2:8888
|
||||
```
|
||||
|
||||
3.Re-deploy Harbor refering to previous section "Managing Harbor's lifecycle".
|
||||
3.Re-deploy Harbor referring to previous section "Managing Harbor's lifecycle".
|
||||
### For HTTPS protocol
|
||||
1.Enable HTTPS in Harbor by following this [guide](https://github.com/goharbor/harbor/blob/master/docs/configure_https.md).
|
||||
2.Modify docker-compose.yml
|
||||
@ -360,7 +360,7 @@ proxy:
|
||||
hostname = 192.168.0.2:8888
|
||||
```
|
||||
|
||||
4.Re-deploy Harbor refering to previous section "Managing Harbor's lifecycle".
|
||||
4.Re-deploy Harbor referring to previous section "Managing Harbor's lifecycle".
|
||||
|
||||
|
||||
## Performance tuning
|
||||
|
@ -93,7 +93,7 @@ If Basic Configuration was not covering your requirements, you can read this sec
|
||||
You can find all configs of Harbor in `make/kubernetes/templates/`. There are specifications of these files:
|
||||
|
||||
- `jobservice.cm.yaml`: ENV and web config of jobservice
|
||||
- `mysql.cm.yaml`: Root passowrd of MySQL
|
||||
- `mysql.cm.yaml`: Root password of MySQL
|
||||
- `ingress.yaml`: Https certification and ingress config. If you are fimiliar with ingress, you can modify it.
|
||||
- `registry.cm.yaml`: Token service certification and registry config
|
||||
Registry use filesystem to store data of images. You can find it like:
|
||||
|
@ -15,7 +15,7 @@ This guide provides instructions to manage roles by LDAP/AD group. You can impor
|
||||
|
||||
## Configure LDAP group settings
|
||||
|
||||
Besides **[basic LDAP configure paremters](https://github.com/vmware/harbor/blob/master/docs/installation_guide.md#optional-parameters)** , LDAP group related configure parameters should be configured, they can be configured before or after installation
|
||||
Besides **[basic LDAP configure parameters](https://github.com/vmware/harbor/blob/master/docs/installation_guide.md#optional-parameters)** , LDAP group related configure parameters should be configured, they can be configured before or after installation
|
||||
|
||||
1. Configure parameters in harbor.cfg before installation
|
||||
|
||||
|
@ -28,7 +28,7 @@ When upgrading your existing Habor instance to a newer version, you may need to
|
||||
mv harbor /my_backup_dir/harbor
|
||||
```
|
||||
|
||||
3. Get the lastest Harbor release package from Github:
|
||||
3. Get the latest Harbor release package from Github:
|
||||
https://github.com/goharbor/harbor/releases
|
||||
|
||||
4. Before upgrading Harbor, perform migration first. The migration tool is delivered as a docker image, so you should pull the image from docker hub. Replace [tag] with the release version of Harbor (e.g. v1.5.0) in the below command:
|
||||
@ -83,7 +83,7 @@ When upgrading your existing Habor instance to a newer version, you may need to
|
||||
docker run -it --rm -v /data/clair-db/:/clair-db -v /data/database:/var/lib/postgresql/data goharbor/harbor-migrator:${tag} --db up
|
||||
```
|
||||
|
||||
**NOTE:** The ${harbor_cfg} will be overwrited, you must move it to your installation directory after migration.
|
||||
**NOTE:** The ${harbor_cfg} will be overwritten, you must move it to your installation directory after migration.
|
||||
|
||||
```
|
||||
docker run -it --rm -v ${harbor_cfg}:/harbor-migration/harbor-cfg/harbor.cfg goharbor/harbor-migrator:[tag] --cfg up
|
||||
|
@ -10,13 +10,13 @@ This guide is for Harbor upgrade test
|
||||
4. Login harbor as usera, push an unsigned image into projecta, then push a signed image to projecta.
|
||||
5. Login harbor as userc, push an unsigned image into projecta, then push a signed image to projeca.
|
||||
6. Login harbor as userd, push each image one time.
|
||||
7. Repeate 4 5 6 to projectb and projectc.
|
||||
7. Repeat 4 5 6 to projectb and projectc.
|
||||
8. Add one endpoint to harbor.
|
||||
9. Add an immediate replication rule to projeca, a schedule rule to projectb, a manual rule to projectc, trigger each rule one time.
|
||||
10. Add 5 system label syslabel1 to syslabel5 and tag syslabel1 and syslabel2 to all unsigned image.
|
||||
11. In each project add 5 project label projlabela to projlabele, add projlabela projlabelb and projlabelc to signed image.
|
||||
12. Trigger one scan all job to scan all images.(For clair enabled instance)
|
||||
13. Update project publicly, content trust, severity and scaning settings.
|
||||
13. Update project publicly, content trust, severity and scanning settings.
|
||||
14. Update Harbor email, token expire read only and scan settings.
|
||||
15. Update repository info.
|
||||
**NOTE**: Create user step is not needed if auth mode is LDAP.
|
||||
|
@ -3,10 +3,10 @@ In harbor.cfg, make sure the attribute ```ui_url_protocol``` is set to ```https`
|
||||
|
||||
### Copy Root Certificate
|
||||
Suppose the Harbor instance is hosted on a machine ```192.168.0.5```
|
||||
If you are using a self-signed cetificate, make sure to copy the CA root cert to ```/etc/docker/certs.d/192.168.0.5/``` and ```~/.docker/tls/192.168.0.5:4443/```
|
||||
If you are using a self-signed certificate, make sure to copy the CA root cert to ```/etc/docker/certs.d/192.168.0.5/``` and ```~/.docker/tls/192.168.0.5:4443/```
|
||||
|
||||
### Enable Docker Content Trust
|
||||
It can be done via setting envrironment variables:
|
||||
It can be done via setting environment variables:
|
||||
|
||||
```
|
||||
export DOCKER_CONTENT_TRUST=1
|
||||
|
Loading…
Reference in New Issue
Block a user