Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sighupio/fury-kubernetes-registry
Kubernetes Fury Registry. Harbor deployment in your Kubernetes Cluster
https://github.com/sighupio/fury-kubernetes-registry
cncf fury harbor k8s kubernetes kubernetesfury kustomize module registry sighup
Last synced: about 1 month ago
JSON representation
Kubernetes Fury Registry. Harbor deployment in your Kubernetes Cluster
- Host: GitHub
- URL: https://github.com/sighupio/fury-kubernetes-registry
- Owner: sighupio
- License: bsd-3-clause
- Created: 2020-04-03T10:11:45.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T10:30:42.000Z (about 2 months ago)
- Last Synced: 2024-10-28T13:38:42.339Z (about 2 months ago)
- Topics: cncf, fury, harbor, k8s, kubernetes, kubernetesfury, kustomize, module, registry, sighup
- Language: Shell
- Homepage: https://sighup.io
- Size: 1.08 MB
- Stars: 5
- Watchers: 8
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Kubernetes Fury Registry
**Kubernetes Fury Registry** provides all components necessary to deploy a container registry on top of Kubernetes based on the [Harbor project][harbor-site] for the [Kubernetes Fury Distribution (KFD)][kfd-repo].
If you are new to KFD please refer to the [official documentation][kfd-docs] on how to get started with KFD.
## Packages
Kubernetes Fury Registry provides the following packages:
| Package | Version | Description |
| ------------------------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Harbor](katalog/harbor) | `v2.7.0` | Harbor is an open-source container image registry that secures images with role-based access control, scans images for vulnerabilities, and signs images as trusted. |
Click on each package to see its full documentation.
## Compatibility
| Kubernetes Version | Compatibility | Notes |
| ------------------ | :----------------: | --------------------------------------------------- |
| `1.28.x` | :white_check_mark: | Conformance tests passed. |
| `1.29.x` | :white_check_mark: | Conformance tests passed. |
| `1.30.x` | :white_check_mark: | Conformance tests passed. |
| `1.31.x` | :white_check_mark: | Conformance tests passed. |
The table shows the latest 4 compatible versions. Check the [compatibility matrix][compatibility-matrix] for the complete list of all supported versions.
## Usage
### Prerequisites
| Tool | Version | Description |
| --------------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [furyctl][furyctl-repo] | `>=0.6.0` | The recommended tool to download and manage KFD modules and their packages. To learn more about `furyctl` read the [official documentation][furyctl-repo]. |
| [kustomize][kustomize-repo] | `>=3.10.0` | Packages are customized using `kustomize`. To learn how to create your customization layer with `kustomize`, please refer to the [repository][kustomize-repo]. |
All packages in this repository have the following dependencies, for package specific dependencies, please visit the single package's documentation:
### Deployment
1. List the packages you want to deploy and their version in a `Furyfile.yml`
```yaml
bases:
- name: registry/harbor
version: "v3.2.0"
```
> See `furyctl` [documentation][furyctl-repo] for additional details about `Furyfile.yml` format.
2. Execute `furyctl vendor -H` to download the packages
3. Inspect the download packages under `./vendor/katalog/registry/harbor`.
4. Define a `kustomization.yaml` that includes the `./vendor/katalog/registry/harbor` directory as resource.
```yaml
resources:
- ./vendor/katalog/registry/harbor
```
5. Apply the necessary patches. You can see some examples in the [examples directory](examples/).
6. To deploy the packages to your cluster, execute:
```bash
kustomize build . | kubectl apply -f -
```
### Monitoring
The Registry Module also includes metrics and dashboards for Harbor's components.
You can monitor the status of Harbor from the provided Grafana Dashboards. Here are some screenshots:
> click on each screenshot for the full screen version
The following set of alerts is included:
| Alert Name | Summary | Description |
| ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| HarborIsDown | The service of Harbor is Down | [Critical]: Check the deployment of Harbor and all components as they may be down |
### Examples
To see examples on how to customize Kubernetes Fury Registry, please view the [examples](examples) directory.
[harbor-site]: https://goharbor.io/
[kfd-monitoring]: https://github.com/sighupio/fury-kubernetes-monitoring
[furyctl-repo]: https://github.com/sighupio/furyctl
[sighup-page]: https://sighup.io
[kfd-repo]: https://github.com/sighupio/fury-distribution
[kustomize-repo]: https://github.com/kubernetes-sigs/kustomize
[kfd-docs]: https://docs.kubernetesfury.com/docs/distribution/
[compatibility-matrix]: https://github.com/sighupio/fury-kubernetes-registry/blob/master/docs/COMPATIBILITY_MATRIX.md
## Contributing
Before contributing, please read first the [Contributing Guidelines](docs/CONTRIBUTING.md).
### Reporting Issues
In case you experience any problem with the module, please [open a new issue](https://github.com/sighupio/fury-kubernetes-registry/issues/new/choose).
## License
This module is open-source and it's released under the following [LICENSE](LICENSE)