An open source trusted cloud native registry project that stores, signs, and scans content.
Go to file
stonezdj(Daojun Zhang) fb2e0042d0
Rename scan request type (#20288)
Signed-off-by: stonezdj <stone.zhang@broadcom.com>
2024-04-17 09:52:50 +00:00
.github bump golang to 1.22.2 (#20256) 2024-04-12 13:46:29 +08:00
api/v2.0 Rename scan request type (#20288) 2024-04-17 09:52:50 +00:00
contrib Update/improve grafana dashboard (#16661) 2023-06-05 18:49:47 +08:00
docs Upload the harbor log icon as it's referenced by the released Harbor chart (#12670) 2020-08-19 18:49:03 +08:00
icons add SBOM icon (#20270) 2024-04-12 20:12:46 +08:00
make bump golang to 1.22.2 (#20256) 2024-04-12 13:46:29 +08:00
src Rename scan request type (#20288) 2024-04-17 09:52:50 +00:00
tests feat: add test case for customizing OIDC provider name (#20287) 2024-04-17 15:52:58 +08:00
tools Update migration tools (#20075) 2024-03-05 19:51:38 +01:00
.buildbaselog Refresh base images (#17883) 2022-11-29 09:51:35 +08:00
.dockerignore ci: lint the swagger file (#14916) 2021-05-19 10:36:09 +08:00
.gitignore Upgrade harbor-portal to v2.9.0 (#18525) 2023-04-13 18:52:06 +08:00
.gitmessage Update README and .gitmessage 2018-07-17 16:42:03 +08:00
.spectral.yaml Bump up spectral to v6.1.0 (#16263) 2022-01-24 14:05:37 +08:00
ADOPTERS.md add DE-CIX as adopters (#19707) 2023-12-19 08:29:12 +00:00
CHANGELOG.md Spelling 2021-02-19 11:59:15 +08:00
CODEOWNERS Add CODEOWNERS all maintainers 2022-04-07 16:51:40 +03:00
CONTRIBUTING.md bump golang to 1.22.2 (#20256) 2024-04-12 13:46:29 +08:00
LICENSE Replacing copyright notices with "Copyright Project Harbor Authors". 2018-09-19 16:59:36 +00:00
Makefile fix: update TRIVYVERSION=v0.50.1 && TRIVYADAPTERVERSION=v0.31.0 (#20285) 2024-04-16 18:37:16 +08:00
OWNERS.md Update OWNERS.md 2019-10-21 02:34:09 -05:00
README.md Fix docker version to 20.10.10 (#19751) 2023-12-26 16:57:25 +08:00
RELEASES.md Update Support Matrix (#19741) 2023-12-20 07:37:55 +00:00
ROADMAP.md fix typo in ROADMAP.md (#19247) 2023-08-28 17:02:28 +08:00
SECURITY.md docs(readme): fix syntax errors in the document (#18113) 2023-01-30 12:08:47 +02:00
VERSION Bump up version to v2.11.0 (#19747) 2023-12-20 09:21:33 +00:00
codecov.yml Fix path in code cov (#13261) 2020-10-15 10:34:52 +08:00

README.md

Harbor

CI Coverage Status Go Report Card CII Best Practices Codacy Badge Code scanning - action Nightly Status CONFORMANCE_TEST FOSSA Status

notificationCommunity Meeting
The Harbor Project holds bi-weekly community calls in two different timezones. To join the community calls or to watch previous meeting notes and recordings, please visit the meeting schedule.



Note: The main branch may be in an unstable or even broken state during development. Please use releases instead of the main branch in order to get a stable set of binaries.

Harbor

Harbor is an open source trusted cloud native registry project that stores, signs, and scans content. Harbor extends the open source Docker Distribution by adding the functionalities usually required by users such as security, identity and management. Having a registry closer to the build and run environment can improve the image transfer efficiency. Harbor supports replication of images between registries, and also offers advanced security features such as user management, access control and activity auditing.

Harbor is hosted by the Cloud Native Computing Foundation (CNCF). If you are an organization that wants to help shape the evolution of cloud native technologies, consider joining the CNCF. For details about whose involved and how Harbor plays a role, read the CNCF announcement.

Features

  • Cloud native registry: With support for both container images and Helm charts, Harbor serves as registry for cloud native environments like container runtimes and orchestration platforms.
  • Role based access control: Users access different repositories through 'projects' and a user can have different permission for images or Helm charts under a project.
  • Policy based replication: Images and charts can be replicated (synchronized) between multiple registry instances based on policies with using filters (repository, tag and label). Harbor automatically retries a replication if it encounters any errors. This can be used to assist loadbalancing, achieve high availability, and facilitate multi-datacenter deployments in hybrid and multi-cloud scenarios.
  • Vulnerability Scanning: Harbor scans images regularly for vulnerabilities and has policy checks to prevent vulnerable images from being deployed.
  • LDAP/AD support: Harbor integrates with existing enterprise LDAP/AD for user authentication and management, and supports importing LDAP groups into Harbor that can then be given permissions to specific projects.
  • OIDC support: Harbor leverages OpenID Connect (OIDC) to verify the identity of users authenticated by an external authorization server or identity provider. Single sign-on can be enabled to log into the Harbor portal.
  • Image deletion & garbage collection: System admin can run garbage collection jobs so that images(dangling manifests and unreferenced blobs) can be deleted and their space can be freed up periodically.
  • Notary: Support signing container images using Docker Content Trust (leveraging Notary) for guaranteeing authenticity and provenance. In addition, policies that prevent unsigned images from being deployed can also be activated.
  • Graphical user portal: User can easily browse, search repositories and manage projects.
  • Auditing: All the operations to the repositories are tracked through logs.
  • RESTful API: RESTful APIs are provided to facilitate administrative operations, and are easy to use for integration with external systems. An embedded Swagger UI is available for exploring and testing the API.
  • Easy deployment: Harbor can be deployed via Docker compose as well Helm Chart, and a Harbor Operator was added recently as well.

Architecture

For learning the architecture design of Harbor, check the document Architecture Overview of Harbor.

API

  • Harbor RESTful API: The APIs for most administrative operations of Harbor and can be used to perform integrations with Harbor programmatically.

Install & Run

System requirements:

On a Linux host: docker 20.10.10-ce+ and docker-compose 1.18.0+ .

Download binaries of Harbor release and follow Installation & Configuration Guide to install Harbor.

If you want to deploy Harbor on Kubernetes, please use the Harbor chart.

Refer to the documentation for more details on how to use Harbor.

OCI Distribution Conformance Tests

Check the OCI distribution conformance tests report of Harbor.

Compatibility

The compatibility list document provides compatibility information for the Harbor components.

Community

Demos

  • Live Demo - A demo environment with the latest Harbor stable build installed. For additional information please refer to this page.
  • Video Demos - Demos for Harbor features and continuously updated.

Partners and Users

For a list of users, please refer to ADOPTERS.md.

Security

Security Audit

A third party security audit was performed by Cure53 in October 2019. You can see the full report here.

Reporting security vulnerabilities

If you've found a security related issue, a vulnerability, or a potential vulnerability in Harbor please let the Harbor Security Team know with the details of the vulnerability. We'll send a confirmation email to acknowledge your report, and we'll send an additional email when we've identified the issue positively or negatively.

For further details please see our complete security release process.

License

Harbor is available under the Apache 2 license.

This project uses open source components which have additional licensing terms. The official docker images and licensing terms for these open source components can be found at the following locations:

Fossa Status

FOSSA Status