Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .claude/settings.local.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"permissions": {
"allow": [
"Bash(kubectl exec:*)"
],
"deny": []
}
}
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/tech_debt.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ assignees: ''
A clear and concise description of what should be changed/researched. Ex. This piece of the code is not DRY enough [...]

### Links to any relevant code
(optional) i.e. - https://github.com/uds-packages/uds-package-#TEMPLATE_APPLICATION_NAME#/blob/main/README.md?plain=1#L1
(optional) i.e. - https://github.com/uds-packages/uds-package-socketzero/blob/main/README.md?plain=1#L1

### Additional context
Add any other context or screenshots about the technical debt here.
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ Relates to #
## Checklist before merging

- [ ] Test, docs, adr added or updated as needed
- [ ] [Contributor Guide Steps](https://github.com/uds-packages/uds-package-#TEMPLATE_APPLICATION_NAME#/blob/main/CONTRIBUTING.md#developer-workflow) followed
- [ ] [Contributor Guide Steps](https://github.com/uds-packages/uds-package-socketzero/blob/main/CONTRIBUTING.md#developer-workflow) followed
2 changes: 1 addition & 1 deletion .github/workflows/ci-docs-shim.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
strategy:
matrix:
type: [install, upgrade]
flavor: [upstream, registry1, unicorn]
flavor: []
uses: defenseunicorns/uds-common/.github/workflows/callable-ci-docs-shim.yaml@f17368a15fae15275792abf7bf4f7f91d1526929 # v1.16.4
with:
flavor: ${{ matrix.flavor }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
id-token: write
strategy:
matrix:
flavor: [upstream, registry1, unicorn]
flavor: []
architecture: [amd64, arm64]
exclude:
- flavor: registry1
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,5 @@ node_modules/

# VSCode
.vscode/

config.json
71 changes: 71 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

## Project Overview

This is a UDS (Unicorn Delivery Service) package for SocketZero, following the Defense Unicorns UDS package template structure. The package deploys SocketZero application using Zarf and UDS bundle configurations with Helm charts.

## Development Commands

Use the UDS CLI with these tasks defined in `tasks.yaml`:

- `uds run` - Setup k3d cluster and deploy package (default)
- `uds run dev` - Create and deploy bundle on existing cluster (faster iteration)
- `uds run create-dev-package` - Create package with `--skip-sbom` flag
- `uds run test-install` - Test deploying current branch to new cluster
- `uds run test-upgrade` - Test upgrade from latest released package
- `uds run publish-package` - Build, test, and publish packages

### Testing Commands

- `uds run test:all` - Run all tests (health check, ingress, UI tests)
- `uds run test:health-check` - Verify SocketZero deployment is available
- `uds run test:ingress` - Check SocketZero UI accessibility at https://socketzero.uds.dev
- `uds run test:ui` - Run Playwright tests in Docker container

### Package Management

The repository uses common UDS tasks imported from `uds-common` v1.16.4:
- `create:package`, `create:test-bundle` - Package creation
- `deploy:test-bundle` - Bundle deployment
- `setup:k3d-test-cluster` - Test cluster setup
- `lint`, `pull`, `upgrade`, `compliance` - Standard operations

## Architecture

### Package Structure

- **Root `zarf.yaml`** - Main package definition importing from `common/zarf.yaml`
- **`common/zarf.yaml`** - Core component definition with SocketZero Helm chart
- **`bundle/uds-bundle.yaml`** - UDS bundle for testing with dependencies
- **`chart/`** - UDS Package custom resources (SSO, network policies, virtual services)

### Key Components

1. **SocketZero Application** - Deployed via Helm chart from https://github.com/radiusmethod/socketzero-helm.git
2. **UDS Package Resource** - Configures SSO integration and network policies in `chart/templates/uds-package.yaml`
3. **Values Files** - Environment-specific configurations in `values/` directory

### Configuration

- **SSO Integration** - SAML-based authentication configured in UDS Package spec
- **Network Policies** - Ingress/egress rules with Istio gateway exposure on port 1234
- **Service Exposure** - SocketZero service exposed via tenant gateway at `socketzero.{{ domain }}`

## Image Registry

Uses Registry1 Iron Bank image: `registry1.dso.mil/ironbank/radiusmethod/socketzero/receiver:0.5.9`

## Testing Strategy

- **Health Checks** - Kubernetes deployment readiness validation
- **Ingress Testing** - HTTP status verification via curl
- **UI Testing** - Playwright tests running in containerized environment
- **Package Validation** - UDS Package CRD status monitoring

## Variables

Key Zarf variables defined in root `zarf.yaml`:
- `DOMAIN` (default: "uds.dev")
- `EXAMPLE_DB_USERNAME`, `EXAMPLE_DB_ENDPOINT` - Database configuration placeholders
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Welcome to the #TEMPLATE_APPLICATION_DISPLAY_NAME# UDS Package
# Welcome to the SocketZero UDS Package

Thank you for your interest in this Defense Unicorns UDS Package!

Expand Down
23 changes: 23 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
.PHONY: package
package:
uds zarf package create --confirm

.PHONY: bundle
bundle:
uds create bundle --confirm

.PHONY: deploy
deploy:
uds deploy bundle/uds-bundle-socketzero-arm64-dev.tar.zst --confirm --set config="$(cat config.json)"

.PHONY: all
all: package bundle deploy

.DEFAULT_GOAL := help
.PHONY: help
help:
@echo "Available targets:"
@echo " package - Create the zarf package"
@echo " bundle - Create the UDS bundle"
@echo " deploy - Deploy the bundle"
@echo " help - Show this help message"
8 changes: 4 additions & 4 deletions README-template.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# UDS Package #TEMPLATE_APPLICATION_DISPLAY_NAME#
# UDS Package SocketZero

This package is designed to be deployed on [UDS Core](https://github.com/defenseunicorns/uds-core) and is based on the upstream [#TEMPLATE_APPLICATION_DISPLAY_NAME#](#TEMPLATE_CHART_REPO#) chart.
This package is designed to be deployed on [UDS Core](https://github.com/defenseunicorns/uds-core) and is based on the upstream [SocketZero](#TEMPLATE_CHART_REPO#) chart.

> INSERT HERE 1-2 sentence summary of what the application does.

## Pre-requisites

The #TEMPLATE_APPLICATION_DISPLAY_NAME# Package expects to be deployed on top of [UDS Core](https://github.com/defenseunicorns/uds-core) with the dependencies listed below being configured prior to deployment.
The SocketZero Package expects to be deployed on top of [UDS Core](https://github.com/defenseunicorns/uds-core) with the dependencies listed below being configured prior to deployment.

#### Dependency information

Expand All @@ -22,7 +22,7 @@ Add any dependency information here

## Releases

The released packages can be found in [ghcr](https://github.com/uds-packages/#TEMPLATE_APPLICATION_NAME#/pkgs/container/#TEMPLATE_APPLICATION_NAME#).
The released packages can be found in [ghcr](https://github.com/uds-packages/socketzero/pkgs/container/socketzero).

## UDS Tasks (for local dev and CI)

Expand Down
Loading
Loading