archsight 0.1.4 → 0.2.0

data/chart/archsight/values.yaml

@@ -0,0 +1,162 @@
+replicaCount: 1
+
+image:
+  repository: ghcr.io/ionos-cloud/archsight
+  pullPolicy: IfNotPresent
+  # Overrides the image tag whose default is the chart appVersion.
+  tag: ""
+
+imagePullSecrets: []
+nameOverride: ""
+fullnameOverride: ""
+
+serviceAccount:
+  # Specifies whether a service account should be created
+  create: true
+  # Annotations to add to the service account
+  annotations: {}
+  # The name of the service account to use.
+  # If not set and create is true, a name is generated using the fullname template
+  name: ""
+
+podAnnotations: {}
+
+podSecurityContext: {}
+  # fsGroup: 2000
+
+securityContext: {}
+  # capabilities:
+  #   drop:
+  #   - ALL
+  # readOnlyRootFilesystem: true
+  # runAsNonRoot: true
+  # runAsUser: 1000
+
+service:
+  type: ClusterIP
+  port: 80
+  targetPort: 4567
+
+ingress:
+  enabled: false
+  className: ""
+  annotations: {}
+    # kubernetes.io/ingress.class: nginx
+    # kubernetes.io/tls-acme: "true"
+  hosts:
+    - host: chart-example.local
+      paths:
+        - path: /
+          pathType: ImplementationSpecific
+  tls: []
+  #  - secretName: chart-example-tls
+  #    hosts:
+  #      - chart-example.local
+
+resources: {}
+  # limits:
+  #   cpu: 100m
+  #   memory: 128Mi
+  # requests:
+  #   cpu: 100m
+  #   memory: 128Mi
+
+autoscaling:
+  enabled: false
+  minReplicas: 1
+  maxReplicas: 100
+  targetCPUUtilizationPercentage: 80
+  # targetMemoryUtilizationPercentage: 80
+
+nodeSelector: {}
+
+tolerations: []
+
+affinity: {}
+
+# Application specific configuration
+app:
+  resourcesDir: /resources
+  env: production
+
+# Strategy for populating the /resources directory
+# Options are "emptyDir", "configMap", "persistence" (PVC), or usage of "extraVolumes"
+content:
+  # type: "emptyDir" | "configMap" | "persistence" | "custom"
+  # - emptyDir: Simple, ephemeral. Good if using initContainers to fetch data.
+  # - configMap: Mounts a ConfigMap. Good for small, static datasets.
+  # - persistence: Mounts a PersistentVolumeClaim. Good for large datasets.
+  # - custom: Do not create the main volume automatically; rely on extraVolumes/extraVolumeMounts.
+  type: emptyDir
+
+  configMap:
+    # If true, creating a ConfigMap from the `data` below.
+    create: false
+    # Name of the ConfigMap to mount (if create: false) or create (if create: true)
+    # If create: true and name is empty, fullname + "-resources" is used.
+    name: ""
+    # Data to inject into the ConfigMap (filename: content)
+    data:
+      # sample.yaml: |
+      #   apiVersion: architecture/v1alpha1
+      #   kind: Analysis
+      #   ...
+      {}
+
+  persistence:
+    enabled: false
+    # existingClaim: my-claim
+    storageClass: ""
+    accessModes:
+      - ReadWriteOnce
+    size: 1Gi
+    annotations: {}
+
+# Add sidecars or initContainers (e.g., for git-sync)
+initContainers: []
+  # Example: Fetching from a private repository using a specific Secret
+  # - name: git-sync
+  #   image: alpine/git
+  #   env:
+  #     - name: GIT_TOKEN
+  #       valueFrom:
+  #         secretKeyRef:
+  #           name: my-git-credentials
+  #           key: token
+  #   command: ["/bin/sh", "-c"]
+  #   args:
+  #     - "git clone https://oauth2:$GIT_TOKEN@github.com/my-org/my-private-repo.git /resources"
+  #   volumeMounts:
+  #     - name: resources
+  #       mountPath: /resources
+
+sidecars: []
+  # Example: Periodically update resources from a private repository
+  # - name: git-sync-private
+  #   image: alpine/git
+  #   env:
+  #     - name: GIT_TOKEN
+  #       valueFrom:
+  #         secretKeyRef:
+  #           name: my-git-credentials
+  #           key: token
+  #   command: ["/bin/sh", "-c"]
+  #   args:
+  #     - |
+  #       cd /resources
+  #       # Ensure the remote uses the current token
+  #       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
+
+# Custom volumes and mounts if you need more control
+extraVolumes: []
+extraVolumeMounts: []
+
+# Command arguments (passed to ENTRYPOINT ["archsight"])
+args: ["web", "--port", "4567", "-H", "0.0.0.0", "--production"]

data/docs/architecture.md

@@ -0,0 +1,39 @@
+# Architecture
+
+## Technology Stack
+
+- **Backend**: Sinatra (REST API)
+- **Frontend**: Vue 3 + Vue Router 4
+- **Build Tool**: Vite
+- **Styling**: Pico CSS v2.x
+- **Icons**: Iconoir
+- **Visualization**: GraphViz (@hpcc-js/wasm, client-side)
+- **Editor**: Lexical
+
+## Directory Structure
+
+```text
+archsight/
+├── exe/archsight              # CLI executable
+├── frontend/                  # Vue 3 SPA
+│   ├── src/
+│   │   ├── components/        # Vue components (40+)
+│   │   ├── composables/       # Reusable composables
+│   │   ├── router/            # Vue Router config
+│   │   └── css/               # Styles
+│   └── vite.config.js         # Vite build config
+├── 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 API + static file serving
+│           └── doc/           # Documentation (markdown)
+├── docs/                      # Project documentation
+└── test/                      # Test suite
+```

data/docs/docker.md

@@ -0,0 +1,49 @@
+# Docker
+
+Archsight is available as a Docker image from the GitHub Container Registry.
+
+## Image
+
+```
+ghcr.io/ionos-cloud/archsight
+```
+
+The image is based on `ruby:4.0-alpine3.23`, exposes port **4567**, and includes a healthcheck.
+
+## Quick Start
+
+```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)
+
+## Environment Variables
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `ARCHSIGHT_RESOURCES_DIR` | Path to resources directory inside the container | `/resources` |
+| `APP_ENV` | Application environment | `production` |
+
+## Building Locally
+
+```bash
+docker build -t archsight .
+docker run -p 4567:4567 -v "/path/to/resources:/resources" archsight
+```

data/{lib/archsight/web/doc → docs}/import.md

@@ -104,8 +104,9 @@ Lists repositories from a GitLab instance and generates child Import resources.
 - `host` - GitLab host (required)
 - `exploreGroups` - If "true", explore all visible groups (default: false)
 - `repoOutputPath` - Output path for repository handler results
-- `fallbackTeam` - Default team when no contributor match found
-- `botTeam` - Team for bot-only repositories
+- `fallbackTeam` - Default team when no contributor match found (propagated to child imports)
+- `botTeam` - Team for bot-only repositories (propagated to child imports)
+- `corporateAffixes` - Comma-separated corporate username affixes for team matching, e.g., "ionos,1and1" (propagated to child imports)
 
 **Environment:**
 - `GITLAB_TOKEN` - Personal access token (required)
@@ -119,6 +120,9 @@ Lists repositories from a GitHub organization and generates child Import resourc
 **Configuration:**
 - `org` - GitHub organization (required)
 - `repoOutputPath` - Output path for repository handler results
+- `fallbackTeam` - Default team when no contributor match found (propagated to child imports)
+- `botTeam` - Team for bot-only repositories (propagated to child imports)
+- `corporateAffixes` - Comma-separated corporate username affixes for team matching, e.g., "ionos,1and1" (propagated to child imports)
 
 **Environment:**
 - `GITHUB_TOKEN` - GitHub Personal Access Token (required)
@@ -140,6 +144,7 @@ Analyzes a single git repository and generates a TechnologyArtifact resource.
 - `sccPath` - Path to scc binary (default: scc)
 - `fallbackTeam` - Default team when no contributor match found
 - `botTeam` - Team for bot-only repositories
+- `corporateAffixes` - Comma-separated corporate username affixes for team matching (e.g., "ionos,1and1"). Enables matching git usernames like `jsmith-ionos` or `ionos-jsmith` to team member "John Smith". Without this, corporate username pattern matching is inactive.
 
 **Output:** Generates one TechnologyArtifact resource with:
 - Code analysis metrics (languages, LOC, estimated cost)
@@ -287,6 +292,7 @@ metadata:
     import/config/host: gitlab.company.com
     import/config/repoOutputPath: generated/repositories.yaml
     import/config/fallbackTeam: "Team:Platform"
+    import/config/corporateAffixes: "ionos,1and1"
 spec: {}
 ```
 
@@ -305,6 +311,8 @@ metadata:
     import/config/gitUrl: git@gitlab.company.com:company/my-service.git
     import/config/archived: "false"
     import/config/visibility: internal
+    import/config/fallbackTeam: "Team:Platform"
+    import/config/corporateAffixes: "ionos,1and1"
     import/outputPath: generated/repositories.yaml
 spec: {}
 ---

data/{lib/archsight/web/doc → docs}/index.md.erb

@@ -7,7 +7,7 @@ Welcome to the Architecture Documentation System. This documentation covers how
 - [Tool Guide](/doc/tool) - How to use the architecture tool
 - [Query Syntax](/doc/search) - Search and filter resources
 - [Architecture Modeling](/doc/modeling) - How to model your architecture
-- [REST API Documentation](/api/docs) - JSON API for programmatic access
+- [REST API Documentation](/docs/api) - JSON API for programmatic access
 
 ## Resource Model
 
@@ -73,3 +73,5 @@ Resources representing technology infrastructure and artifacts.
 - [TOGAF](/doc/togaf) - TOGAF framework reference
 - [Icons Reference](/doc/icons) - Available icons for resource types
 - [Computed Annotations](/doc/computed_annotations) - Available computed annotations
+- [Import System](/doc/import) - Declarative data imports from external sources
+- [License Scanning](/doc/licenses) - Repository license detection and dependency analysis

data/docs/kubernetes.md

@@ -0,0 +1,149 @@
+# Kubernetes (Helm)
+
+A Helm chart for deploying [Archsight](https://github.com/ionos-cloud/archsight) on Kubernetes.
+
+## Prerequisites
+
+- Kubernetes 1.19+
+- Helm 3.2.0+
+
+## Installing the Chart
+
+### From OCI Registry (Recommended)
+
+```bash
+helm install my-archsight oci://ghcr.io/ionos-cloud/archsight/charts/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
+
+```bash
+helm delete my-archsight
+```