archsight 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae63f749045a2339cdabe1cb1136ec0078ac1b62d75c0c3fb1c6707c8317f025
-  data.tar.gz: 61fd3a424e8943314724a044089aa79a696af34f6529f3c6116f2cf411d5167d
+  metadata.gz: 750620aa30b68f0a3cfa0f53be2d717ae0496b829e5ecc588a904b3bf39dbd10
+  data.tar.gz: 8ddf46b557c7830212d0e699149ce2b53b9476c7748fc90c82480f22be226047
 SHA512:
-  metadata.gz: 5bd774f6c2c04f358b0ff43f2c4729d70e23f0adb03f0baccde2c81e5eb91b809f1b04d5fdcd8f1ac6a460d1b00731684c63b4d8fa03d1533947240f0da799d7
-  data.tar.gz: bfabe9ef2312bf3c243b52679a09dbb57ed5048d757bc5267479ad83d1242d61b2543d85e9be6cdfcf45f14602e0a8ba174b6a75444334be5a446103eb4d4ab6
+  metadata.gz: 39b0cc9b3b321c1e2627197a8f2edb13bdb8fe78273e315b70c886d05d64da534769850f5991e70d6c38d549f7229988d3d2e03bbd075f01e9aad0b4b4aad802
+  data.tar.gz: 69c4784e97d7c2aa01bf1030109a621f1eacdf4d7fe131d2e7c56eb29b42524ed3a68c69f97003ef804a7e38cedf118dc186157a948e5c81479191927955fa94

data/Dockerfile

@@ -1,11 +1,14 @@
 # Build stage
 FROM ruby:4.0-alpine3.23 AS builder
 
-RUN apk add --no-cache build-base git libffi-dev yaml-dev
+RUN apk add --no-cache build-base git libffi-dev yaml-dev nodejs npm
 
 WORKDIR /app
 COPY . .
 
+# Build frontend assets
+RUN cd frontend && npm ci && npm run build
+
 # Build and install the gem
 RUN gem build archsight.gemspec && \
     gem install --no-document archsight-*.gem
@@ -13,8 +16,6 @@ RUN gem build archsight.gemspec && \
 # Runtime stage
 FROM ruby:4.0-alpine3.23
 
-RUN apk add --no-cache graphviz
-
 # Copy installed gems from builder (including default gems that were updated)
 COPY --from=builder /usr/local/bundle /usr/local/bundle
 COPY --from=builder /usr/local/lib/ruby/gems /usr/local/lib/ruby/gems
@@ -35,4 +36,4 @@ HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \
     CMD wget --no-verbose --tries=1 --spider http://localhost:4567/ || exit 1
 
 ENTRYPOINT ["archsight"]
-CMD ["web", "--port", "4567"]
+CMD ["web", "--port", "4567", "--host", "0.0.0.0"]

data/README.md

@@ -7,6 +7,10 @@
 
 Ruby gem for visualizing and managing enterprise architecture documentation using YAML resources with GraphViz visualization. Inspired by ArchiMate 3.2.
 
+| Service view | Artifact view |
+|:---:|:---:|
+| ![Service detail with graph and relations](media/service.jpg) | ![Artifact detail with metadata](media/artifact.jpg) |
+
 ## Installation
 
 Add to your Gemfile:
@@ -23,8 +27,6 @@ gem install archsight
 
 ## Quick Start
 
-### Option 1: CLI
-
 ```bash
 # Start web server (looks for resources in current directory)
 archsight web
@@ -38,29 +40,7 @@ ARCHSIGHT_RESOURCES_DIR=/path/to/resources archsight web
 
 Access at: <http://localhost:4567>
 
-### Option 2: Docker
-
-```bash
-# Run web server (default)
-docker run -p 4567:4567 -v "/path/to/resources:/resources" ghcr.io/ionos-cloud/archsight
-
-# Run in production mode with logging
-docker run -p 4567:4567 -v "/path/to/resources:/resources" ghcr.io/ionos-cloud/archsight web --production
-
-# Run lint
-docker run -v "/path/to/resources:/resources" ghcr.io/ionos-cloud/archsight lint -r /resources
-
-# Run any command
-docker run ghcr.io/ionos-cloud/archsight version
-```
-
-Access web interface at: <http://localhost:4567>
-
-**Notes:**
-
-- Volume mount `-v "/path/to/resources:/resources"` mounts your resources directory
-- Default command starts the web server on port 4567
-- Pass subcommands directly (lint, version, console, template)
+Also available as [Docker](docs/docker.md) image and [Helm chart](docs/kubernetes.md).
 
 ## CLI Commands
 
@@ -79,6 +59,7 @@ archsight version            # Show version
 ```bash
 archsight web [--resources PATH] [--port PORT] [--host HOST]
               [--production] [--disable-reload] [--enable-logging]
+              [--inline-edit]
 ```
 
 | Option | Description |
@@ -89,6 +70,7 @@ archsight web [--resources PATH] [--port PORT] [--host HOST]
 | `--production` | Run in production mode (quiet startup) |
 | `--disable-reload` | Disable the reload button in the UI |
 | `--enable-logging` | Enable request logging (default: false in dev, true in prod) |
+| `--inline-edit` | Enable inline editing to save directly to source files |
 
 ## Features
 
@@ -119,7 +101,7 @@ claude mcp add --transport sse ionos-architecture http://localhost:4567/mcp/sse
 **Browse & Search:**
 
 - Browse resources by type (Products, Services, Components, Requirements, etc.)
-- Search by name or tag using the [query language](lib/archsight/web/doc/search.md)
+- Search by name or tag using the [query language](docs/search.md)
 - Filter by annotations (quality attributes, status, frameworks)
 
 **Visualization:**
@@ -129,6 +111,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:
@@ -150,42 +159,18 @@ Detailed documentation is available in the web interface under the Help menu:
 
 | Guide | Description |
 |-------|-------------|
-| [Modeling Guide](lib/archsight/web/doc/modeling.md) | How to model architecture using resource types and relations |
-| [Query Language](lib/archsight/web/doc/search.md) | Full query syntax reference for searching resources |
-| [Computed Annotations](lib/archsight/web/doc/computed_annotations.md) | Aggregating values across relations |
-| [ArchiMate Reference](lib/archsight/web/doc/archimate.md) | ArchiMate concepts and mapping |
-| [TOGAF Reference](lib/archsight/web/doc/togaf.md) | TOGAF alignment and concepts |
+| [Modeling Guide](docs/modeling.md) | How to model architecture using resource types and relations |
+| [Query Language](docs/search.md) | Full query syntax reference for searching resources |
+| [Computed Annotations](docs/computed_annotations.md) | Aggregating values across relations |
+| [ArchiMate Reference](docs/archimate.md) | ArchiMate concepts and mapping |
+| [TOGAF Reference](docs/togaf.md) | TOGAF alignment and concepts |
+| [Architecture](docs/architecture.md) | Technology stack and directory structure |
+| [Docker](docs/docker.md) | Running Archsight in Docker |
+| [Kubernetes](docs/kubernetes.md) | Helm chart deployment guide |
 
 ## Architecture
 
-### Technology Stack
-
-- **Web Framework**: Sinatra
-- **Templating**: Haml
-- **Styling**: Pico CSS v2.x
-- **Interactivity**: HTMX
-- **Icons**: Iconoir (1,671+ icons)
-- **Visualization**: GraphViz (@hpcc-js/wasm for client-side SVG)
-
-### Directory Structure
-
-```text
-archsight/
-├── exe/archsight              # CLI executable
-├── lib/
-│   ├── archsight.rb           # Entry point
-│   └── archsight/
-│       ├── cli.rb             # Thor CLI
-│       ├── configuration.rb   # Resources path config
-│       ├── database.rb        # YAML loader and validator
-│       ├── query/             # Query language (lexer, parser, evaluator)
-│       ├── resources/         # Resource types (20+)
-│       ├── annotations/       # Annotation modules
-│       ├── mcp/               # MCP server tools
-│       └── web/               # Sinatra app, views, assets
-│           └── doc/           # Documentation (markdown)
-└── test/                      # Test suite
-```
+See [Architecture](docs/architecture.md) for the technology stack and directory structure.
 
 ## Contributing
 

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,3 @@
+# Archsight Helm Chart
+
+See the full documentation at [docs/kubernetes.md](../../docs/kubernetes.md).

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 }}