Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
firmansyahn authored Feb 2, 2024
1 parent 411231b commit 9ed0ef9
Showing 1 changed file with 36 additions and 8 deletions.
44 changes: 36 additions & 8 deletions charts/netbox/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,8 @@
[NetBox](https://netbox.readthedocs.io/) is an IP address management (IPAM) and
data center infrastructure management (DCIM) tool.

Forked from [bootc/netbox-chart](https://github.com/bootc/netbox-chart)

**Note:** This repository was forked from [bootc/netbox-chart](https://github.com/bootc/netbox-chart) at versions
v5.0.0 and up are from this fork and will have diverged from any changes in the original fork. A list of changes can be seen in the CHANGELOG.
v5.0.0 and up are from this fork will have diverged from any changes in the original fork. A list of changes can be seen in the CHANGELOG.

**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/startechnica/apps/issues/new/choose)**

Expand All @@ -15,10 +13,10 @@ v5.0.0 and up are from this fork and will have diverged from any changes in the
```console
$ helm repo add startechnica https://startechnica.github.io/apps
$ helm install netbox \
--set postgresql.auth.postgresPassword=[password1] \
--set postgresql.auth.password=[password2] \
--set redis.auth.password=[password3] \
startechnica/netbox
--set postgresql.auth.postgresPassword=<posgres-password> \
--set postgresql.auth.password=<db-password> \
--set redis.auth.password=<redis-password> \
startechnica/netbox
```
⚠️ **WARNING:** Please see [Production Usage](#production-usage) below before using this chart for production environment.

Expand Down Expand Up @@ -76,9 +74,9 @@ affinity:
requiredDuringSchedulingIgnoredDuringExecution:
- labelSelector:
matchLabels:
app.kubernetes.io/component: server
app.kubernetes.io/instance: netbox
app.kubernetes.io/name: netbox
app.kubernetes.io/component: netbox
topologyKey: kubernetes.io/hostname
```
Expand Down Expand Up @@ -168,6 +166,36 @@ PostgreSQL chart was upgraded from 5.x.x to 7.x.x, and Redis from 8.x.x to

The following table lists the configurable parameters for this chart and their default values.

### Global parameters

| Name | Description | Value |
| ------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----- |
| `global.imageRegistry` | Global Docker image registry | `""` |
| `global.imagePullSecrets` | Global Docker registry secret names as an array | `[]` |
| `global.storageClass` | Global StorageClass for Persistent Volume(s) | `""` |
| `global.namespaceOverride` | Override the namespace for resource deployed by the chart, but can itself be overridden by the local namespaceOverride | `""` |


### Common parameters

| Name | Description | Value |
| -------------------------- | ----------------------------------------------------------------------------------------------------------------- | --------------- |
| `kubeVersion` | Force target Kubernetes version (using Helm capabilities if not set) | `""` |
| `nameOverride` | String to partially override common.names.fullname template with a string (will prepend the release name) | `""` |
| `namespaceOverride` | String to fully override common.names.namespace | `""` |
| `fullnameOverride` | String to fully override common.names.fullname template with a string | `""` |
| `commonAnnotations` | Annotations to add to all deployed objects | `{}` |
| `commonLabels` | Labels to add to all deployed objects | `{}` |
| `schedulerName` | Name of the Kubernetes scheduler (other than default) | `""` |
| `clusterDomain` | Kubernetes DNS Domain name to use | `cluster.local` |
| `extraDeploy` | Array of extra objects to deploy with the release (evaluated as a template) | `[]` |
| `diagnosticMode.enabled` | Enable diagnostic mode (all probes will be disabled and the command will be overridden) | `false` |
| `diagnosticMode.command` | Command to override all containers in the deployment | `[]` |
| `diagnosticMode.args` | Args to override all containers in the deployment | `[]` |


### Netbox parameters

| Parameter | Description | Default |
| ------------------------------------------------|---------------------------------------------------------------------|----------------------------------------------|
| `replicaCount` | The desired number of NetBox pods | `1` |
Expand Down

0 comments on commit 9ed0ef9

Please sign in to comment.