From ea84990551abde0c8cde3fb8d62009cb59b4fda7 Mon Sep 17 00:00:00 2001 From: Stuart Clements Date: Tue, 17 Dec 2019 15:22:30 +0100 Subject: [PATCH] More linking --- docs/harbor-doc-reorg/_index.md | 2 +- .../build_customize_contribute/_index.md | 8 ++++++++ .../install_config/configuration/_index.md | 4 ++++ .../configuration/configure_authentication.md | 10 +++++++++- .../configuration/configure_notary_content_trust.md | 8 ++++++++ .../configuration/customize_token_service.md | 6 ++++++ .../install_config/configuration/general_settings.md | 10 +++++++++- .../install_config/configuration/initial_config_ui.md | 3 +++ .../configuration/reconfigure_manage_lifecycle.md | 7 +++++++ docs/harbor-doc-reorg/working_with_projects/_index.md | 5 +++-- 10 files changed, 58 insertions(+), 5 deletions(-) diff --git a/docs/harbor-doc-reorg/_index.md b/docs/harbor-doc-reorg/_index.md index 75c6da343..b878d30ff 100644 --- a/docs/harbor-doc-reorg/_index.md +++ b/docs/harbor-doc-reorg/_index.md @@ -47,7 +47,7 @@ This section describes how to use and maintain Harbor after deployment. These da - [Garbage Collection](administration/garbage_collection/_index.md) - [Upgrading Harbor](administration/upgrade/_index.md) - [Upgrade Harbor and Migrate Data](administration/upgrade/upgrade_migrate_data.md) - - [Roll Back an Upgrade](administration/upgrade/roll_back_upgrade.md) + - [Roll Back an Upgrade](administration/upgrade/roll_back_upgrade.md) - [Manage the Harbor Instance](administration/manage_harbor/_index.md) - [Access Harbor Logs](administration/manage_harbor/access_logs.md) diff --git a/docs/harbor-doc-reorg/build_customize_contribute/_index.md b/docs/harbor-doc-reorg/build_customize_contribute/_index.md index ec8e484b2..1ba31fa96 100644 --- a/docs/harbor-doc-reorg/build_customize_contribute/_index.md +++ b/docs/harbor-doc-reorg/build_customize_contribute/_index.md @@ -1,3 +1,11 @@ # Build, Customize, and Contribute to Harbor This section describes how developers can build from Harbor source code, customize their deployments, and contribute to the open-source Harbor project. + +- [Build Harbor from Source Code](compile_guide.md) +- [Developing the Harbor Frontend](ui_contribution_get_started.md) +- [Customize the Harbor Look & Feel ](customize_look_feel.md) +- [Developing for Internationalization](developer_guide_i18n.md) +- [Using Make](use_make.md) +- [View and test Harbor REST API via Swagger](configure_swagger.md) +- [Registry Landscape](registry_landscape.md) diff --git a/docs/harbor-doc-reorg/install_config/configuration/_index.md b/docs/harbor-doc-reorg/install_config/configuration/_index.md index fc52b9b09..bb4b05f53 100644 --- a/docs/harbor-doc-reorg/install_config/configuration/_index.md +++ b/docs/harbor-doc-reorg/install_config/configuration/_index.md @@ -6,3 +6,7 @@ After you have deployed Harbor, you must perform certain post-deployment configu - [Configure Notary Content Trust](configure_notary_content_trust.md) - [Reconfigure Harbor and Manage the Harbor Lifecycle](reconfigure_manage_lifecycle.md) - [Access Harbor Logs](access_logs.md) + +---------- + +[Back to table of contents](../../_index.md) diff --git a/docs/harbor-doc-reorg/install_config/configuration/configure_authentication.md b/docs/harbor-doc-reorg/install_config/configuration/configure_authentication.md index 0230f1029..89de1a99e 100644 --- a/docs/harbor-doc-reorg/install_config/configuration/configure_authentication.md +++ b/docs/harbor-doc-reorg/install_config/configuration/configure_authentication.md @@ -1,3 +1,7 @@ +[Back to table of contents](../../_index.md) + +---------- + # Authentication Modes and User Accounts Harbor supports different modes for authenticating users and managing user accounts. @@ -159,4 +163,8 @@ You can now use your CLI secret as the password when logging in to Harbor from t sh docker login -u testuser -p cli_secret jt-test.local.goharbor.io -**NOTE**: The CLI secret is associated with the OIDC ID token. Harbor will try to refresh the token, so the CLI secret will be valid after the ID token expires. However, if the OIDC Provider does not provide a refresh token or the refresh fails, the CLI secret becomes invalid. In this case, log out and log back in to Harbor via your OIDC provider so that Harbor can get a new ID token. The CLI secret will then work again. \ No newline at end of file +**NOTE**: The CLI secret is associated with the OIDC ID token. Harbor will try to refresh the token, so the CLI secret will be valid after the ID token expires. However, if the OIDC Provider does not provide a refresh token or the refresh fails, the CLI secret becomes invalid. In this case, log out and log back in to Harbor via your OIDC provider so that Harbor can get a new ID token. The CLI secret will then work again. + +---------- + +[Back to table of contents](../../_index.md) \ No newline at end of file diff --git a/docs/harbor-doc-reorg/install_config/configuration/configure_notary_content_trust.md b/docs/harbor-doc-reorg/install_config/configuration/configure_notary_content_trust.md index 727ab14a0..07a8bdcb1 100644 --- a/docs/harbor-doc-reorg/install_config/configuration/configure_notary_content_trust.md +++ b/docs/harbor-doc-reorg/install_config/configuration/configure_notary_content_trust.md @@ -1,3 +1,7 @@ +[Back to table of contents](../../_index.md) + +---------- + # Configure Notary Content Trust In harbor.yml, make sure https is enabled, and the attributes `ssl_cert` and `ssl_cert_key` are pointed to valid certificates. For more information about generating https certificate please refer to: [Configuring HTTPS for Harbor](configure_https.md) @@ -24,3 +28,7 @@ Because by default the local directory for storing meta files for notary client alias notary="notary -s https://192.168.0.5:4443 -d ~/.docker/trust --tlscacert /etc/docker/certs.d/192.168.0.5/ca.crt" ``` + +---------- + +[Back to table of contents](../../_index.md) diff --git a/docs/harbor-doc-reorg/install_config/configuration/customize_token_service.md b/docs/harbor-doc-reorg/install_config/configuration/customize_token_service.md index 6afa5e127..459ddfa23 100644 --- a/docs/harbor-doc-reorg/install_config/configuration/customize_token_service.md +++ b/docs/harbor-doc-reorg/install_config/configuration/customize_token_service.md @@ -1,3 +1,7 @@ +[Back to table of contents](../../_index.md) + +---------- + # Customize the Harbor Token Service Harbor requires Docker client to access the Harbor registry with a token. The procedure to generate a token is like [Docker Registry v2 authentication](https://github.com/docker/distribution/blob/master/docs/spec/auth/token.md). Firstly, you should make a request to the token service for a token. The token is signed by the private key. After that, you make a new request with the token to the Harbor registry, Harbor registry will verify the token with the public key in the rootcert bundle. Then Harbor registry will authorize the Docker client to push/pull images. @@ -57,4 +61,6 @@ $ cp /root/cert/root.crt ../registry/root.crt 6.Then you can push/pull images to see if your own certificate works. Please refer [User Guide](https://github.com/goharbor/harbor/blob/master/docs/user_guide.md) for more info. +---------- +[Back to table of contents](../../_index.md) diff --git a/docs/harbor-doc-reorg/install_config/configuration/general_settings.md b/docs/harbor-doc-reorg/install_config/configuration/general_settings.md index 58ea6266e..4b7d45852 100644 --- a/docs/harbor-doc-reorg/install_config/configuration/general_settings.md +++ b/docs/harbor-doc-reorg/install_config/configuration/general_settings.md @@ -1,3 +1,7 @@ +[Back to table of contents](../../_index.md) + +---------- + # Administrator Options ## Managing Project Creation @@ -21,4 +25,8 @@ $ docker push 10.117.169.182/demo/ubuntu:14.04 The push refers to a repository [10.117.169.182/demo/ubuntu] 0271b8eebde3: Preparing denied: The system is in read only mode. Any modification is prohibited. -``` \ No newline at end of file +``` + +---------- + +[Back to table of contents](../../_index.md) \ No newline at end of file diff --git a/docs/harbor-doc-reorg/install_config/configuration/initial_config_ui.md b/docs/harbor-doc-reorg/install_config/configuration/initial_config_ui.md index 1a736aa35..f5f2bbe60 100644 --- a/docs/harbor-doc-reorg/install_config/configuration/initial_config_ui.md +++ b/docs/harbor-doc-reorg/install_config/configuration/initial_config_ui.md @@ -3,3 +3,6 @@ - [Configure Authentication](configure_authentication.md) - [Other General Settings](general_settings.md) +---------- + +[Back to table of contents](../../_index.md) \ No newline at end of file diff --git a/docs/harbor-doc-reorg/install_config/configuration/reconfigure_manage_lifecycle.md b/docs/harbor-doc-reorg/install_config/configuration/reconfigure_manage_lifecycle.md index 456ed3a0b..abf004ebc 100644 --- a/docs/harbor-doc-reorg/install_config/configuration/reconfigure_manage_lifecycle.md +++ b/docs/harbor-doc-reorg/install_config/configuration/reconfigure_manage_lifecycle.md @@ -1,3 +1,7 @@ +[Back to table of contents](../../_index.md) + +---------- + # Reconfigure Harbor and Manage the Harbor Lifecycle You can use `docker-compose` to manage the lifecycle of Harbor. Some useful commands are listed below. You must run the commands in the same directory as `docker-compose.yml`. @@ -71,3 +75,6 @@ $ sudo docker-compose up -d Please check the [Docker Compose command-line reference](https://docs.docker.com/compose/reference/) for more on docker-compose. +---------- + +[Back to table of contents](../../_index.md) \ No newline at end of file diff --git a/docs/harbor-doc-reorg/working_with_projects/_index.md b/docs/harbor-doc-reorg/working_with_projects/_index.md index 0249c3908..6cc2dc4b5 100644 --- a/docs/harbor-doc-reorg/working_with_projects/_index.md +++ b/docs/harbor-doc-reorg/working_with_projects/_index.md @@ -2,5 +2,6 @@ This section describes how users with the developer, master, and project administrator roles manage and participate in Harbor projects. The Harbor administrator can also perform all of these tasks. - - +- [Project Creation](project_overview.md) +- [Project Configuration](project_configuration.md) +- [Working with Images, Tags, and Helm Charts](working_with_images.md) \ No newline at end of file