IPAM-API

Setup

Prerequisites

• go version v1.25.3+
• docker version 4.45.0+.
• MongoDB Compass 1.47.+

Build Application

docker compose up --build

Pre-populate Netbox with required configuration

python3 ./hack/netbox-scripts/setup_netbox_prefixes

Operating

MongoDB Compass

Connection String:mongodb://admin:secretpassword@localhost:27017/?authSource=admin

Netbox

URL: http://localhost:8000

Username: admin & Password: admin

Shell to IPAM-API

docker exec -it ipam-api bash

IPAM-CLI

Executable within container IPAM-API.

./ipam-cli --help

ArgoCD

apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
  name: ipam-api
  namespace: argocd
spec:
  project: default
  source:
    path: .
    repoURL: oci://ncr.sky.nhn.no/ghcr/vitistack/helm/ipam-api
    targetRevision: 1.*
    helm:
      valueFiles:
          - values.prod.yaml
      parameters:
      - name: secrets.mongodb
        value: jsdfjkvnu253228asdfce385732sdfghwerh3545  
      - name: secrets.netbox
        value: yurmvld361sdfm4imdnej35ngotvm3583adkvnh3
      - name: secrets.splunk
        value: d5e33e86-3371-4d8c-b7a1-645c563f722e
      - name: encryption.encKey
        value: 86728dkfnhdj3744
      - name: encryption.encIv
        value: sdfkji4nfnkser45
      - name: backup.failedJobsHistoryLimit
        value: "6"
      - name: backup.sshKey
        value: |
          -----BEGIN OPENSSH PRIVATE KEY-----
          -----END OPENSSH PRIVATE KEY-----
  destination:
    server: "https://kubernetes.default.svc"
    namespace: ipam-system
  syncPolicy:
      automated:
          selfHeal: true
          prune: true
      syncOptions:
      - CreateNamespace=true

License

Copyright 2025.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.