archsight 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae63f749045a2339cdabe1cb1136ec0078ac1b62d75c0c3fb1c6707c8317f025
-  data.tar.gz: 61fd3a424e8943314724a044089aa79a696af34f6529f3c6116f2cf411d5167d
+  metadata.gz: 37f0d691fd1bdc0ce5b3a250c6bf0dc269b2586682ab1c46c25546cfa8d9c251
+  data.tar.gz: 56069d4dbdc04607c00c51af729433f63792ffbca81e79d785d5a0d1cfe75b25
 SHA512:
-  metadata.gz: 5bd774f6c2c04f358b0ff43f2c4729d70e23f0adb03f0baccde2c81e5eb91b809f1b04d5fdcd8f1ac6a460d1b00731684c63b4d8fa03d1533947240f0da799d7
-  data.tar.gz: bfabe9ef2312bf3c243b52679a09dbb57ed5048d757bc5267479ad83d1242d61b2543d85e9be6cdfcf45f14602e0a8ba174b6a75444334be5a446103eb4d4ab6
+  metadata.gz: 4e1bc599625fc4ed0d7b16a9a9fd61d420faa4e58186e4ff6ebd6a15ca2ff05e44c1fa88164d45f45acfcd01d09d676d09bd90b57b31fcba30961d823212089e
+  data.tar.gz: 820b19c2650828976882d746fffa9674ebd7da9c418dcb663096c3cfdaf366aeecd4cb11fcd241b14c400f5d80adf21243774b45de6c6a6137736e832591dda0

data/README.md

@@ -21,6 +21,12 @@ Or install directly:
 gem install archsight
 ```
 
+### Option 2: Helm (Kubernetes)
+
+```bash
+helm install archsight oci://ghcr.io/ionos-cloud/archsight/charts/archsight
+```
+
 ## Quick Start
 
 ### Option 1: CLI
@@ -129,6 +135,33 @@ claude mcp add --transport sse ionos-architecture http://localhost:4567/mcp/sse
 - Dark mode support
 - Layer-based color scheme (Business, Application, Technology, Data)
 
+### Resource Editor
+
+Create and edit resources through the web interface:
+
+**Edit existing resource:**
+
+- Navigate to any resource detail page
+- Click the "Edit" button (only available for non-generated resources)
+- Modify annotations and relations
+- Generate YAML and copy to clipboard
+
+**Create new resource:**
+
+- Go to any kind listing (e.g., /kinds/ApplicationComponent)
+- Click "New" button
+- Fill in required fields
+- Add relations using cascading dropdowns
+- Generate YAML and copy to clipboard
+
+The editor supports:
+
+- Type-aware form fields (dropdowns for enums, number inputs, URL validation)
+- Markdown textarea for descriptions
+- Relation management with cascading dropdowns
+- Validation before YAML generation
+- One-click copy to clipboard
+
 ### Validation
 
 Validate YAML syntax and verify all relationship references:

data/chart/archsight/Chart.yaml

@@ -0,0 +1,6 @@
+apiVersion: v2
+name: archsight
+description: A Helm chart for ArchSight
+type: application
+version: 0.1.1
+appVersion: "0.1.4"

data/chart/archsight/README.md

@@ -0,0 +1,160 @@
+# Archsight Helm Chart
+
+A Helm chart for deploying [Archsight](https://github.com/ionos-cloud/archsight) on Kubernetes.
+
+## Introduction
+
+This chart bootstraps an Archsight deployment on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. It is designed to be flexible in how you provide the architecture "resources" (YAML files) to the application.
+
+## Prerequisites
+
+- Kubernetes 1.19+
+- Helm 3.2.0+
+
+## Installing the Chart
+
+### From OCI Registry (Recommended)
+
+To install the chart from the GitHub Container Registry:
+
+```bash
+helm install my-archsight oci://ghcr.io/ionos-cloud/archsight/charts/archsight
+```
+
+### From Local Source
+
+To install the chart with the release name `my-archsight` from local source:
+
+```bash
+helm install my-archsight ./chart/archsight
+```
+
+## Configuration
+
+The following table lists the configurable parameters of the Archsight chart and their default values.
+
+| Parameter | Description | Default |
+|-----------|-------------|---------|
+| `image.repository` | Docker image repository | `archsight` |
+| `image.tag` | Docker image tag | `""` (uses appVersion) |
+| `service.type` | Kubernetes Service type | `ClusterIP` |
+| `service.port` | Service port | `80` |
+| `ingress.enabled` | Enable Ingress resource | `false` |
+| `app.resourcesDir` | Directory where app looks for resources | `/resources` |
+
+### Resource Management Strategies
+
+The most important configuration is how you provide your architecture YAML files to the application. This is controlled by the `content.type` parameter.
+
+#### 1. ConfigMap (Simple / Static)
+Best for small deployments where the architecture definitions rarely change or are small enough to fit in a ConfigMap (1MB limit).
+
+```yaml
+content:
+  type: configMap
+  configMap:
+    create: true
+    data:
+      analysis.yaml: |
+        apiVersion: architecture/v1alpha1
+        kind: Analysis
+        metadata:
+          name: MyAnalysis
+        # ... content ...
+```
+
+#### 2. Persistence (Manual Management)
+Mounts a Persistent Volume. You are responsible for putting files into this volume (e.g., manually copying them or having another process write to it).
+
+```yaml
+content:
+  type: persistence
+  persistence:
+    enabled: true
+    size: 1Gi
+```
+
+#### 3. EmptyDir + Git Sync (GitOps / Recommended)
+Uses an `emptyDir` volume that is shared between the main container and init containers. This allows you to fetch your architecture definitions from a Git repository at startup.
+
+**Example values.yaml configuration (Public Repo):**
+
+```yaml
+content:
+  type: emptyDir
+
+initContainers:
+  - name: git-sync
+    image: alpine/git
+    # Clone your architecture repo into /resources
+    args: ["clone", "--depth", "1", "https://github.com/my-org/my-architecture.git", "/resources"]
+    volumeMounts:
+      - name: resources
+        mountPath: /resources
+```
+
+**Example values.yaml configuration (Private Repo):**
+
+To use a private repository, create a Kubernetes Secret containing your git token (e.g., `git-credentials` with key `token`) and reference it:
+
+```yaml
+content:
+  type: emptyDir
+
+initContainers:
+  - name: git-sync
+    image: alpine/git
+    env:
+      - name: GIT_TOKEN
+        valueFrom:
+          secretKeyRef:
+            name: git-credentials
+            key: token
+    command: ["/bin/sh", "-c"]
+    # Use the env var in the URL so the token is not exposed in the pod spec
+    args:
+      - "git clone https://oauth2:$GIT_TOKEN@github.com/my-org/my-private-repo.git /resources"
+    volumeMounts:
+      - name: resources
+        mountPath: /resources
+```
+
+
+### Sidecars (Auto-Refresh)
+
+If you want your application to update dynamically when the git repository changes (without restarting the pod), you can add a sidecar container that periodically pulls changes.
+
+**Example (Private Repo with 60s Refresh Loop):**
+
+```yaml
+sidecars:
+  - name: git-refresher
+    image: alpine/git
+    env:
+      - name: GIT_TOKEN
+        valueFrom:
+          secretKeyRef:
+            name: git-credentials
+            key: token
+    command: ["/bin/sh", "-c"]
+    args:
+      - |
+        cd /resources
+        # Set the remote URL with the token to ensure authentication
+        git remote set-url origin "https://oauth2:${GIT_TOKEN}@github.com/my-org/my-private-repo.git"
+        while true; do
+          git pull
+          sleep 60
+        done
+    volumeMounts:
+      - name: resources
+        mountPath: /resources
+```
+
+## Uninstalling the Chart
+
+To uninstall/delete the `my-archsight` deployment:
+
+```bash
+helm delete my-archsight
+```

data/chart/archsight/templates/NOTES.txt

@@ -0,0 +1,22 @@
+1. Get the application URL by running these commands:
+{{- if .Values.ingress.enabled }}
+  {{- range $host := .Values.ingress.hosts }}
+  {{- range .paths }}
+  http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }}
+  {{- end }}
+  {{- end }}
+{{- else if contains "NodePort" .Values.service.type }}
+  export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "archsight.fullname" . }})
+  export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
+  echo http://$NODE_IP:$NODE_PORT
+{{- else if contains "LoadBalancer" .Values.service.type }}
+     NOTE: It may take a few minutes for the LoadBalancer IP to be available.
+           You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "archsight.fullname" . }}'
+  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "archsight.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
+  echo http://$SERVICE_IP:{{ .Values.service.port }}
+{{- else if contains "ClusterIP" .Values.service.type }}
+  export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "archsight.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
+  export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
+  echo "Visit http://127.0.0.1:8080 to use your application"
+  kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT
+{{- end }}

data/chart/archsight/templates/_helpers.tpl

@@ -0,0 +1,62 @@
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "archsight.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Create a default fully qualified app name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+If release name contains chart name it will be used as a full name.
+*/}}
+{{- define "archsight.fullname" -}}
+{{- if .Values.fullnameOverride }}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- $name := default .Chart.Name .Values.nameOverride }}
+{{- if contains $name .Release.Name }}
+{{- .Release.Name | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
+{{- end }}
+{{- end }}
+{{- end }}
+
+{{/*
+Create chart name and version as used by the chart label.
+*/}}
+{{- define "archsight.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Common labels
+*/}}
+{{- define "archsight.labels" -}}
+helm.sh/chart: {{ include "archsight.chart" . }}
+{{ include "archsight.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "archsight.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "archsight.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "archsight.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create }}
+{{- default (include "archsight.fullname" .) .Values.serviceAccount.name }}
+{{- else }}
+{{- default "default" .Values.serviceAccount.name }}
+{{- end }}
+{{- end }}

data/chart/archsight/templates/deployment.yaml

@@ -0,0 +1,114 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ include "archsight.fullname" . }}
+  labels:
+    {{- include "archsight.labels" . | nindent 4 }}
+spec:
+  {{- if not .Values.autoscaling.enabled }}
+  replicas: {{ .Values.replicaCount }}
+  {{- end }}
+  selector:
+    matchLabels:
+      {{- include "archsight.selectorLabels" . | nindent 6 }}
+  template:
+    metadata:
+      {{- with .Values.podAnnotations }}
+      annotations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      labels:
+        {{- include "archsight.selectorLabels" . | nindent 8 }}
+    spec:
+      {{- with .Values.imagePullSecrets }}
+      imagePullSecrets:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      serviceAccountName: {{ include "archsight.serviceAccountName" . }}
+      securityContext:
+        {{- toYaml .Values.podSecurityContext | nindent 8 }}
+      
+      {{- with .Values.initContainers }}
+      initContainers:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+
+      containers:
+        - name: {{ .Chart.Name }}
+          securityContext:
+            {{- toYaml .Values.securityContext | nindent 12 }}
+          image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
+          imagePullPolicy: {{ .Values.image.pullPolicy }}
+          env:
+            - name: ARCHSIGHT_RESOURCES_DIR
+              value: {{ .Values.app.resourcesDir | quote }}
+            - name: APP_ENV
+              value: {{ .Values.app.env | quote }}
+          {{- if .Values.args }}
+          args:
+            {{- toYaml .Values.args | nindent 12 }}
+          {{- end }}
+          ports:
+            - name: http
+              containerPort: 4567
+              protocol: TCP
+          livenessProbe:
+            httpGet:
+              path: /
+              port: http
+            initialDelaySeconds: 5
+            periodSeconds: 30
+            timeoutSeconds: 3
+            failureThreshold: 3
+          readinessProbe:
+            httpGet:
+              path: /
+              port: http
+            initialDelaySeconds: 5
+            periodSeconds: 30
+            timeoutSeconds: 3
+            failureThreshold: 3
+          resources:
+            {{- toYaml .Values.resources | nindent 12 }}
+          volumeMounts:
+            {{- if ne .Values.content.type "custom" }}
+            - name: resources
+              mountPath: {{ .Values.app.resourcesDir }}
+            {{- end }}
+            {{- with .Values.extraVolumeMounts }}
+            {{- toYaml . | nindent 12 }}
+            {{- end }}
+
+        {{- with .Values.sidecars }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
+
+      volumes:
+        {{- if eq .Values.content.type "emptyDir" }}
+        - name: resources
+          emptyDir: {}
+        {{- else if eq .Values.content.type "configMap" }}
+        - name: resources
+          configMap:
+            name: {{ default (printf "%s-resources" (include "archsight.fullname" .)) .Values.content.configMap.name }}
+        {{- else if eq .Values.content.type "persistence" }}
+        - name: resources
+          persistentVolumeClaim:
+            claimName: {{ default (printf "%s-resources" (include "archsight.fullname" .)) .Values.content.persistence.existingClaim }}
+        {{- end }}
+        {{- with .Values.extraVolumes }}
+        {{- toYaml . | nindent 8 }}
+        {{- end }}
+
+      {{- with .Values.nodeSelector }}
+      nodeSelector:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.affinity }}
+      affinity:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.tolerations }}
+      tolerations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}

data/chart/archsight/templates/ingress.yaml

@@ -0,0 +1,56 @@
+{{- if .Values.ingress.enabled -}}
+{{- $fullName := include "archsight.fullname" . -}}
+{{- $svcPort := .Values.service.port -}}
+{{- if semverCompare ">=1.19-0" .Capabilities.KubeVersion.GitVersion -}}
+apiVersion: networking.k8s.io/v1
+{{- else if semverCompare ">=1.14-0" .Capabilities.KubeVersion.GitVersion -}}
+apiVersion: networking.k8s.io/v1beta1
+{{- else -}}
+apiVersion: extensions/v1beta1
+{{- end }}
+kind: Ingress
+metadata:
+  name: {{ $fullName }}
+  labels:
+    {{- include "archsight.labels" . | nindent 4 }}
+  {{- with .Values.ingress.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+spec:
+  {{- if .Values.ingress.className }}
+  ingressClassName: {{ .Values.ingress.className }}
+  {{- end }}
+  {{- if .Values.ingress.tls }}
+  tls:
+    {{- range .Values.ingress.tls }}
+    - hosts:
+        {{- range .hosts }}
+        - {{ . | quote }}
+        {{- end }}
+      secretName: {{ .secretName }}
+    {{- end }}
+  {{- end }}
+  rules:
+    {{- range .Values.ingress.hosts }}
+    - host: {{ .host | quote }}
+      http:
+        paths:
+          {{- range .paths }}
+          - path: {{ .path }}
+            {{- if and .pathType (semverCompare ">=1.18-0" $.Capabilities.KubeVersion.GitVersion) }}
+            pathType: {{ .pathType }}
+            {{- end }}
+            backend:
+              {{- if semverCompare ">=1.19-0" $.Capabilities.KubeVersion.GitVersion }}
+              service:
+                name: {{ $fullName }}
+                port:
+                  number: {{ $svcPort }}
+              {{- else }}
+              serviceName: {{ $fullName }}
+              servicePort: {{ $svcPort }}
+              {{- end }}
+          {{- end }}
+    {{- end }}
+{{- end }}

data/chart/archsight/templates/resources-configmap.yaml

@@ -0,0 +1,10 @@
+{{- if and (eq .Values.content.type "configMap") .Values.content.configMap.create }}
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: {{ default (printf "%s-resources" (include "archsight.fullname" .)) .Values.content.configMap.name }}
+  labels:
+    {{- include "archsight.labels" . | nindent 4 }}
+data:
+  {{- toYaml .Values.content.configMap.data | nindent 2 }}
+{{- end }}

data/chart/archsight/templates/resources-pvc.yaml

@@ -0,0 +1,23 @@
+{{- if and (eq .Values.content.type "persistence") .Values.content.persistence.enabled (not .Values.content.persistence.existingClaim) }}
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: {{ printf "%s-resources" (include "archsight.fullname" .) }}
+  labels:
+    {{- include "archsight.labels" . | nindent 4 }}
+  {{- with .Values.content.persistence.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+spec:
+  accessModes:
+    {{- range .Values.content.persistence.accessModes }}
+    - {{ . | quote }}
+    {{- end }}
+  resources:
+    requests:
+      storage: {{ .Values.content.persistence.size | quote }}
+  {{- if .Values.content.persistence.storageClass }}
+  storageClassName: {{ .Values.content.persistence.storageClass | quote }}
+  {{- end }}
+{{- end }}

data/chart/archsight/templates/service.yaml

@@ -0,0 +1,15 @@
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ include "archsight.fullname" . }}
+  labels:
+    {{- include "archsight.labels" . | nindent 4 }}
+spec:
+  type: {{ .Values.service.type }}
+  ports:
+    - port: {{ .Values.service.port }}
+      targetPort: {{ .Values.service.targetPort }}
+      protocol: TCP
+      name: http
+  selector:
+    {{- include "archsight.selectorLabels" . | nindent 4 }}

data/chart/archsight/templates/serviceaccount.yaml

@@ -0,0 +1,12 @@
+{{- if .Values.serviceAccount.create -}}
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: {{ include "archsight.serviceAccountName" . }}
+  labels:
+    {{- include "archsight.labels" . | nindent 4 }}
+  {{- with .Values.serviceAccount.annotations }}
+  annotations:
+    {{- toYaml . | nindent 4 }}
+  {{- end }}
+{{- end }}