Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Update: Refresh Outdated Information #521

Merged
merged 1 commit into from
Dec 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/administration/garbage-collection/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ You are able to schedule garbage colleciton on your Harbor interface from the **
* **Hourly**: Run garbage collection at the beginning of every hour.
* **Daily**: Run garbage collection at midnight every day.
* **Weekly**: Run garbage collection at midnight every Saturday.
* **Custom**: Run garbage collection according to a `cron` job.
* **Custom**: Run garbage collection according to a `cron` task.

1. For the **Workers** item, you are able to select the number of workers that can execute GC tasks in parallel.
1. To **Allow garbage collection on untagged artifacts**, select the option. If you have this option turned on, the next time Garbage collect runs on your Harbor instance, Harbor will delete untagged artifacts and then perform garbage collection on them.
Expand All @@ -47,7 +47,7 @@ View garbage collection runs in the **Garbage Collection History** table on the

Each time you run garbage collection on your Harbor instance, Harbor will track some information about the run including:

* **Job ID:** Unique numerical value assigned by Harbor when a run is initiated.
* **Task ID:** Unique numerical value assigned by Harbor when a run is initiated.
* **Trigger Type:** How the run was initiated, either Manual or by Schedule.
* **Dry Run:** If the run was a dry run or not.
* **Status:** Current status of the run.
Expand All @@ -61,12 +61,12 @@ Each time you run garbage collection on your Harbor instance, Harbor will track

## Stop in Progress Garbage Collection

You are able to stop any running garbage collection job from the Garbage Collection History table.
You are able to stop any running garbage collection task from the Garbage Collection History table.

1. Navigate to **Administration** > **Clean Up** page and select the **'Garbage Collection'** tab.
1. In the **Garbage Collection History** table, click on the checkbox next to the Job Id of the running garbage collection. You can stop one or more running garbage collection jobs at one time.
1. In the **Garbage Collection History** table, click on the checkbox next to the Task Id of the running garbage collection. You can stop one or more running garbage collection tasks at one time.
1. Click **Stop** and then **Confirm** that you want to stop the garbage collection in the modal.

![Select Garbage collection job from table](../../img/gc-stop-run.png)
![Select Garbage collection task from table](../../img/gc-stop-run.png)

This will only stop the garbage collection job from processing more artifacts. Harbor will not restore any artifact that has already been garbage collected.
This will only stop the garbage collection task from processing more artifacts. Harbor will not restore any artifact that has already been garbage collected.
16 changes: 8 additions & 8 deletions docs/administration/log-rotation/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ By default, Harbor tracks all image pull, push, and delete operations performed
* **Hourly**: Run log rotation at the beginning of every hour.
* **Daily**: Run log rotation at midnight every day.
* **Weekly**: Run log rotation at midnight every Saturday.
* **Custom**: Run log rotation according to a `cron` job.
* **Custom**: Run log rotation according to a `cron` task.
1. Use the **Keep records in** to configure how long audit logs should be kept. Use the drop down-menu to select **Hours** or **Days**. For example, if you set this to 7 days, Harbor will only purge audit logs that are 8 or more days old.

![Log rotation policy configuration](../../img/lr-policy-settings.png)
Expand All @@ -36,12 +36,12 @@ Use the **PURGE NOW** option to manually run a purge immediately, without waitin
## View Log Rotation History
View the purge runs in the **Purge History** table. Harbor tracks information about each purge run, including:

* **Job ID:** Unique numerical value assigned by Harbor when a run is initiated.
* **Task ID:** Unique numerical value assigned by Harbor when a run is initiated.
* **Trigger Type:** How the run was initiated, either Manual or by Schedule.
* **Dry Run:** If the run was a dry run or not.
* **Status:** Current status of the run.
* **Status:** Current status of the run.
* **Creation Time:** Time the run started.
* **Update time:** The last time the run was updated.
* **Update time:** The last time the run was updated.
* **Logs:** A link to the logs generated by the run. If you are performing a Dry Run, this will include an estimate of the artifacts that will be purged.

![Purge history table](../../img/purge-history.png)
Expand All @@ -59,12 +59,12 @@ Harbor will forward all purged records to the audit log forward syslog endpoint

## Stop in Progress Log Rotation

You are able to stop any running log purge job from the Purge History table.
You are able to stop any running log purge task from the Purge History table.

1. Navigate to **Administration** > **Clean Up** page and select the **Log Rotation** tab.
1. In the **Purge History** table, click on the checkbox next to the Job Id of the running log purge job. You can stop one or more running log purge jobs at one time.
1. In the **Purge History** table, click on the checkbox next to the Task Id of the running log purge task. You can stop one or more running log purge tasks at one time.
1. Click **Stop** and then **Confirm** that you want to stop the garbage collection in the modal.

![Select Garbage collection job from table](../../img/lr-stop-run.png)
![Select Garbage collection task from table](../../img/lr-stop-run.png)

This will only stop the log purge job from processing more logs. Harbor will not restore any logs that has already been purged.
This will only stop the log purge task from processing more logs. Harbor will not restore any logs that has already been purged.
Binary file modified docs/img/audit-log-endpoint.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/browse-project-repositories.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/filter-export-vulnerabilities.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/garbage-collection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/gc-history.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/gc-policy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/gc-stop-run.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/log-rotation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/lr-policy-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/lr-policy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/lr-stop-run.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/new-browse-project.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/new-create-project.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/new-search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/purge-history.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 5 additions & 5 deletions docs/install-config/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ The table below lists the some of the key components that are deployed when you

|Component|Version|
|---|---|
|Postgresql|13.3.0|
|Redis|6.0.13|
|Beego|1.9.0|
|Docker/distribution|2.7.1|
|Postgresql|14.10|
|Redis|7.2.2|
|Beego|2.0.6|
|Docker/distribution|2.8.3|
|Helm|2.9.1|
|Swagger-ui|3.22.1|
|Swagger-ui|5.9.1|
4 changes: 2 additions & 2 deletions docs/install-config/harbor-ha-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You can deploy Harbor on Kubernetes via helm to make it highly available. In thi
- Kubernetes cluster 1.10+
- Helm 2.8.0+
- High available ingress controller (Harbor does not manage the external endpoint)
- High available PostgreSQL 9.6+ (Harbor does not handle the deployment of HA of database)
- High available PostgreSQL (Harbor does not handle the deployment of HA of database)
- High available Redis (Harbor does not handle the deployment of HA of Redis)
- PVC that can be shared across nodes or external object storage

Expand Down Expand Up @@ -65,7 +65,7 @@ Configure the followings items in `values.yaml`, you can also set them as parame

## Installation

Install the Harbor helm chart with a release name `my-release`:
Install the Harbor helm chart with a release name `my-release`:

Helm 2:

Expand Down
2 changes: 1 addition & 1 deletion docs/install-config/installation-prereqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The following table lists the software versions that must be installed on the ta

|Software|Version|Description|
|---|---|---|
|Docker Engine|Version 17.06.0-ce+ or higher|For installation instructions, see [Docker Engine documentation](https://docs.docker.com/engine/installation/)|
|Docker Engine|Version 20.10.10-ce+ or higher|For installation instructions, see [Docker Engine documentation](https://docs.docker.com/engine/installation/)|
|Docker Compose|docker-compose (v1.18.0+) or docker compose v2 (docker-compose-plugin)|For installation instructions, see [Docker Compose documentation](https://docs.docker.com/compose/install/)|
|OpenSSL|Latest is preferred|Used to generate certificate and keys for Harbor|

Expand Down