Add Readme.md

Author: bdevcich

ssh-container/README.md

@@ -0,0 +1,56 @@
+# SSH Container for Rabbit User Container Workflows
+
+This container provides SSH access to launcher containers running on Rabbit nodes.
+
+## Overview
+
+The SSH container enables remote access to Rabbit User Container workflows. It requires predetermined UID/GID and generated SSH keys baked into the image for secure authentication.
+
+⚠️ **Security Note**: Images are user-specific and the generated keys must be kept secure - loss of keys means loss of access to the container.
+
+## Quick Start
+
+```bash
+# 1. Generate SSH keys
+make ssh-keys client-keys
+
+# 2. Build with your UID/GID  
+make build UID=1060 GID=100
+
+# 3. Test locally
+make run
+make connect
+
+# 4. Publish to your registry
+docker tag ssh-container:latest your-registry.com/ssh-container:latest
+docker push your-registry.com/ssh-container:latest
+```
+
+## NNF Container Profile
+
+Create a profile referencing your published image:
+
+```yaml
+apiVersion: nnf.cray.hpe.com/v1alpha1
+kind: NnfContainerProfile
+metadata:
+  name: ssh-container-profile
+spec:
+  containers:
+  - name: ssh-launcher
+    image: your-registry.com/ssh-container:latest
+    ports:
+    - name: ssh
+      port: 22
+```
+
+## Customization
+
+Add tools by modifying the Dockerfile:
+
+```dockerfile
+# Add your tools after the base setup
+RUN apt-get update && apt-get install -y \
+    your-tool \
+    && rm -rf /var/lib/apt/lists/*
+```