Merge pull request #10523 from stuclem/quick-start-script

Added quickstart script

docs/1.10/index.md

@@ -6,7 +6,7 @@ This is the main table of contents for the Harbor 1.10.x documentation.
 
 This section describes how to install Harbor and perform the required initial configurations. These day 1 operations are performed by the Harbor Administrator.
 
-- [Introduction](install_config/index.md) 
+- [Introduction](install_config/README.md) 
 - [Test Harbor with the Demo Server](install_config/demo_server.md)
 - [Harbor Compatibility List](install_config/harbor_compatibility_list.md)
 - [Harbor Installation Prerequisites](install_config/installation_prereqs.md)
@@ -15,6 +15,7 @@ This section describes how to install Harbor and perform the required initial co
 - [Configure the Harbor YML File](install_config/configure_yml_file.md)
 - [Run the Installer Script](install_config/run_installer_script.md)
 - [Deploying Harbor with High Availability via Helm](install_config/harbor_ha_helm.md)
+- [Deploy Harbor with the Quick Installation Script](install_config/quick_install_script.md)
 - [Troubleshooting Harbor Installation](install_config/troubleshoot_installation.md)
 - [Reconfigure Harbor and Manage the Harbor Lifecycle](install_config/reconfigure_manage_lifecycle.md)
 - [Customize the Harbor Token Service](install_config/customize_token_service.md)
@@ -24,7 +25,7 @@ This section describes how to install Harbor and perform the required initial co
 
 This section describes how to use and maintain Harbor after deployment. These day 2 operations are performed by the Harbor Administrator.
 
-- [Introduction](administration/index.md)
+- [Introduction](administration/README.md)
 - [Configuring Authentication](administration/configure_authentication/configure_authentication.md)
    - [Configure Database Authentication](administration/configure_authentication/db_auth.md)
    - [Configure LDAP/Active Directory Authentication](administration/configure_authentication/ldap_auth.md)
@@ -55,7 +56,7 @@ This section describes how to use and maintain Harbor after deployment. These da
 
 This section describes how users with the developer, master, and project administrator roles manage and participate in Harbor projects.
 
-- [Introduction](working_with_projects/index.md)
+- [Introduction](working_with_projects/README.md)
 - [Create Projects](working_with_projects/create_projects.md)
     - [Assign Users to a Project](working_with_projects/add_users.md)
 - [Project Configuration](working_with_projects/project_configuration.md)
@@ -82,4 +83,6 @@ This section describes how developers can build from Harbor source code, customi
 - [Developing for Internationalization](build_customize_contribute/developer_guide_i18n.md)
 - [Using Make](build_customize_contribute/use_make.md)
 - [View and test Harbor REST API via Swagger](build_customize_contribute/configure_swagger.md)
-- [Registry Landscape](build_customize_contribute/registry_landscape.md)
+- [Registry Landscape](build_customize_contribute/registry_landscape.md)
+
+See also the list of [Articles from the Harbor Community](https://github.com/goharbor/harbor/blob/master/docs/README.md#articles-from-the-community).

docs/1.10/install_config/README.md

@@ -22,10 +22,16 @@ The standard Harbor installation process involves the following stages:
 1. [Configure the Harbor YML File](configure_yml_file.md)
 1. [Run the Installer Script](run_installer_script.md)
 
-You can also use Helm to install Harbor on a Kubernetes cluster, to make it highly available. For information about installing Harbor with Helm on a Kubernetes cluster, see the [Deploying Harbor with High Availability via Helm](harbor_ha_helm.md).
-
 If installation fails, see [Troubleshooting Harbor Installation](troubleshoot_installation.md).
 
+## Quick Installation
+
+You can run a script that deploys Harbor to Ubuntu 18.04 with a single command. For information, see [Deploy Harbor with the Quick Installation Script](quick_install_script.md).
+
+## Deploy Harbor on Kubernetes
+
+You can also use Helm to install Harbor on a Kubernetes cluster, to make it highly available. For information about installing Harbor with Helm on a Kubernetes cluster, see [Deploying Harbor with High Availability via Helm](harbor_ha_helm.md).
+
 ## Post-Installation Configuration
 
 For information about how manage your deployed Harbor instance, see [Reconfigure Harbor and Manage the Harbor Lifecycle](reconfigure_manage_lifecycle.md). 

docs/1.10/install_config/configure_https.md

@@ -177,7 +177,7 @@ After setting up HTTPS for Harbor, you can verify the HTTPS connection by perfor
    
 ## What to Do Next ##
 
-- If the verification succeeds, see [Harbor Administration](../administration/index.md) for information about using Harbor.
+- If the verification succeeds, see [Harbor Administration](../administration/README.md) for information about using Harbor.
 - If installation fails, see [Troubleshooting Harbor Installation](troubleshoot_installation.md).
 
 ----------

docs/1.10/install_config/quick_install_script.md

@@ -0,0 +1,37 @@
+# Deploy Harbor with the Quick Installation Script
+
+The Harbor community has provided a script that with a single command prepares an Ubuntu 18.04 machine for Harbor and deploys the latest stable version.
+
+This script installs Harbor with an HTTP connection, Clair, and the Chart Repository Service. It does not install Notary, which requires HTTPS.
+
+## Prerequisites
+
+You have a machine or VM that is running Ubuntu 18.04. The script does not work on earlier versions of Ubuntu.
+
+## Procedure
+
+1. Download the `harbor.sh` script from [gist.github.com](https://gist.github.com/kacole2/95e83ac84fec950b1a70b0853d6594dc) to your Ubuntu machine or VM.
+1. Grant run permissions to the current user.
+
+   ```$ chmod u+x```
+1. Run the script as superuser.
+
+   ```$ sudo ./harbor.sh```
+1. Select whether to deploy Harbor using the IP address or FQDN of the host machine. 
+
+   This is the address at which you access the Harbor interface and the registry service.
+   
+   - To use the IP address, enter `1`.
+   - To use the FQDN, enter `2`.
+   
+   The script takes several minutes to run. As it runs, the script downloads the necessary packages and dependencies from Ubuntu, installs the latest stable versions of Docker and Docker Compose, and installs the latest stable version of Harbor.
+   
+1. When the script reports `Harbor Installation Complete`, log in to your new Harbor instance. 
+
+   ```$ docker login <harbor_ip_or_FQDN>```
+   
+   - User name: `admin`
+   - Password: `VMware12345` 
+1. Enter the Harbor address in a browser to log in to the Harbor interface.
+
+After deployment, you can enable HTTPS and Notary by reconfiguring the installation. For information, see [Reconfigure Harbor and Manage the Harbor Lifecycle](reconfigure_manage_lifecycle.md).

docs/1.10/install_config/run_installer_script.md

@@ -104,7 +104,7 @@ After you update `daemon.json`, you must restart both Docker Engine and Harbor.
 
 ## What to Do Next ##
 
-- If the installation succeeds, see [Harbor Administration](../administration/index.md) for information about using Harbor.
+- If the installation succeeds, see [Harbor Administration](../administration/README.md) for information about using Harbor.
 - If you deployed Harbor with HTTP and you want to secure the connections to Harbor, see [Configure HTTPS Access to Harbor](configure_https.md).
 - If installation fails, see [Troubleshooting Harbor Installation](troubleshoot_installation.md).
 

docs/README.md

@@ -6,7 +6,7 @@ For older versions of the docs, please select the appropriate `release-1.xx.x` b
 
 See also the [Harbor Architecture Overview](https://github.com/vmware/harbor/wiki/Architecture-Overview-of-Harbor).
 
-# Articles from the community
+# Articles from the Harbor Community
 
 [Python SDK](../contrib/registryapi)