Skip to content

Commit

Permalink
Promote per chart README
Browse files Browse the repository at this point in the history
  • Loading branch information
LeoColomb authored Sep 18, 2024
1 parent df11c38 commit 624bdcd
Show file tree
Hide file tree
Showing 2 changed files with 490 additions and 15 deletions.
35 changes: 20 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,23 @@
# NetBox
# Netbox Helm Charts

[NetBox](https://netbox.readthedocs.io/) is an IP address management (IPAM) and
data center infrastructure management (DCIM) tool.
> The official [Helm](https://helm.sh) charts repository for [Netbox](https://netbox.dev).
## TL;DR
[![Build Status](https://github.com/netbox-community/netbox-chart/actions/workflows/ci.yml/badge.svg)](https://github.com/netbox-community/netbox-chart/actions/workflows/ci.yml)
[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/netbox)](https://artifacthub.io/packages/search?repo=netbox)

```shell
helm install netbox --devel oci://ghcr.io/netbox-community/netbox-chart/netbox
```

> [!tip]
> Please see [Production Usage](#production-usage) below before using this chart for real.
## About

## Prerequisites
This Git repository houses the official Helm charts for Netbox.

- Kubernetes [1.25+](https://kubernetes.io/releases/)
- Helm [3.10+](https://helm.sh/docs/topics/version_skew/)
Do you have any questions?
Before opening an issue on Github, please join [our Slack][https://join.slack.com/t/netdev-community/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ]
and ask for help in the [`#netbox-chart`][https://netdev-community.slack.com/archives/C01Q6B100R2] channel.

## Installing the Chart
| Chart | Version |
|:---------------:|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| [`netbox/netbox`](charts/netbox/) | [![Chart Version](https://img.shields.io/badge/dynamic/json?label=netbox&query=version&url=https%3A%2F%2Fartifacthub.io%2Fapi%2Fv1%2Fpackages%2Fhelm%2Fnetbox%2Fnetbox)](https://artifacthub.io/packages/helm/netbox/netbox) |

To install the chart with the release name `my-release` and default configuration:
## Quickstart

```shell
helm install my-release --devel oci://ghcr.io/netbox-community/netbox-chart/netbox
Expand Down Expand Up @@ -506,6 +504,13 @@ The chart dependencies on PostgreSQL and Redis have been upgraded, so you may
need to take action depending on how you have configured the chart. The
PostgreSQL chart was upgraded from 5.x.x to 7.x.x, and Redis from 8.x.x to
9.x.x.
See docs on your preferred sources:
* [Charts docs on Artifact Hub](https://artifacthub.io/packages/search?org=netbox)
* [Charts respective READMEs](charts)
* [Charts discovery](https://helm.sh/docs/helm/helm_search/)
```sh
helm search netbox
```

## License

Expand Down
Loading

0 comments on commit 624bdcd

Please sign in to comment.