Getting Started & Usage

What customers should do first

Once Harbor is deployed, the first goal is to confirm that it is usable as a secure internal registry.

• Log in to the Harbor UI
• Create a project
• Assign the right users or roles
• Push a test image
• Pull the image from Docker or Kubernetes
• Confirm vulnerability scanning works

Harbor object model in simple terms

Projects

Projects are the main organizational unit in Harbor. They group related images and control access.

Repositories

Repositories are where image versions are stored. Example: harbor.example.com/team-a/my-service

Artifacts

Artifacts are the actual stored objects, such as image tags and OCI artifacts.

Users and roles

Harbor uses role-based access control to determine who can view projects, push images, delete artifacts, or manage settings.

Basic usage examples

Push a test image:

docker pull nginx:latest
docker tag nginx:latest harbor.example.com/demo/nginx:latest
docker push harbor.example.com/demo/nginx:latest


Pull a test image:

docker pull harbor.example.com/demo/nginx:latest


Use a Harbor image in Kubernetes:

containers:
 - name: app
   image: harbor.example.com/demo/nginx:latest
imagePullSecrets:
 - name: harbor-pull-secret


What good usage looks like

• Developers or CI build the image
• Image is pushed into Harbor
• Harbor scans and stores the image
• Approved workloads pull the image into Kubernetes
• Platform teams manage access and retention centrally

Shakudo SaaS-first quick start

This section is for customers using Harbor as a managed component inside Shakudo. Start from the Shakudo platform instead of installing or exposing Harbor manually.

1. Access the component in Shakudo

• Sign in to your Shakudo workspace with your organization-approved account.
• Open the workspace or environment where this component is enabled.
• Go to the Applications or component catalog area and select Harbor.
• If you cannot see the component, ask your workspace administrator to confirm that it is enabled for your role and environment.

2. Open the component UI

• Use the Shakudo-provided Open, Launch, or Access action for Harbor.
• Let Shakudo handle authentication, networking, and workspace routing. Avoid using internal service URLs unless your administrator explicitly provides them.
• Confirm that the component opens in the expected workspace before creating or changing resources.

3. Complete a first safe use case

Open the Harbor registry UI, browse an approved project, push or inspect a container image, and confirm tags, scan status, and access permissions are visible.

• Use a small non-production example first, especially when testing credentials, scans, model calls, or data connections.
• Name the test clearly so other workspace users can recognize it as a first-run validation.

4. Monitor and validate the result

• Check the component UI for run status, logs, traces, scan results, job history, or project activity, depending on the component.
• Return to Shakudo if you need platform-level status, access control changes, or administrator support.
• Record any errors, missing permissions, or unexpected results before retrying with production workloads.

5. Next steps

• Review the use cases, administration, and troubleshooting pages in this knowledge base for deeper examples.
• For production usage, follow your team’s Shakudo workspace policies for credentials, data access, resource limits, and approvals.
• Previous getting-started content snapshot
• The page content below was present before this SaaS-first section was added. It is retained here as an inline snapshot so existing guidance is not lost.
• heading_1: Getting Started & Usage; heading_2: What customers should do first; paragraph: Once Harbor is deployed, the first goal is to confirm that it is usable as a secure internal registry.; bulleted_list_item: Log in to the Harbor UI; bulleted_list_item: Create a project; bulleted_list_item: Assign the right users or roles; bulleted_list_item: Push a test image; bulleted_list_item: Pull the image from Docker or Kubernetes; bulleted_list_item: Confirm vulnerability scanning works; heading_2: Harbor object model in simple terms; heading_3: Projects; paragraph: Projects are the main organizational unit in Harbor. They group related images and control access.

‍