Resource Creation Wizard
The Gyre Resource Creation Wizard provides a guided, user-friendly interface for creating any of the 10 supported FluxCD resource types. It bridges the gap between manual YAML editing and high-level resource management.
Accessing the Wizard
You can access the Resource Creation Wizard in several ways:
- Global "Create" Button: Click the "+" or "Create Resource" button in the sidebar or top navigation.
- Resource List Pages: On any resource list page (e.g., GitRepositories), click the "Create" button in the header.
- Command Palette: Press
Ctrl+K(orCmd+Kon macOS) and type "Create [Resource Type]".
Guided Workflow
When you select a resource type, the wizard initializes with a default template.
Form Mode (Default)
Form mode provides a structured, validated way to configure your resource:
- Sections: Fields are grouped into logical sections (Basic, Source, Authentication, etc.).
- Smart Validation: Fields validate in real-time (e.g., K8s name patterns, sync intervals).
- Conditional Visibility: Fields only appear when relevant (e.g., SSH fields only show when using an SSH URL).
- Tooltips: Hover over the "?" icon next to any field for detailed explanations and links to official documentation.
YAML Mode
For power users, Gyre integrates a full Monaco Editor (the same editor powering VS Code):
- Live Sync: Changes in the form reflect immediately in the YAML, and vice versa.
- Syntax Highlighting: Full YAML syntax highlighting and error detection.
- Comments Preservation: Gyre preserves your custom YAML comments when switching between modes.
- Copy Manifest: Easily copy the generated YAML to your clipboard for use elsewhere.
Advanced Features
Dynamic Field Visibility
The wizard uses showIf logic to reduce clutter. For example, in a GitRepository template:
- Selecting "Branch" as the reference type shows the "Branch" field and hides "Tag" or "Commit".
- Setting a URL that starts with
ssh://can trigger the visibility of authentication secrets.
Array and Object Management
Gyre handles complex Kubernetes structures:
- Dynamic Lists: Add or remove items from arrays (e.g.,
dependsOnorpatches) with a single click. - Nested Objects: Configure complex nested specifications through sub-forms.
Persistence
The wizard remembers your progress. If you navigate away or refresh the page, your current form values are saved in LocalStorage and restored when you return to that specific template.
Common Configurations
GitRepository with SSH Authentication
To use a private Git repository with SSH:
- Select the GitRepository template.
- In Source Configuration, enter your SSH URL (e.g.,
ssh://git@github.com/org/repo). - In the Authentication section, provide the name of the Kubernetes Secret containing your SSH private key in the Secret Name field.
- Gyre will automatically generate the
spec.secretRefin the YAML.
Kustomization with Dependencies
To deploy a resource that depends on another:
- Select the Kustomization template.
- In Deployment Settings, find the Dependencies (dependsOn) field.
- Click Add Item to add a new dependency.
- Enter the
nameandnamespaceof the Kustomization that must be ready first.
Resource Field Reference
Gyre supports all 10 FluxCD resource types. Click on a resource type below for detailed information on its specific fields, or refer to the official FluxCD documentation.
| Resource Type | FluxCD Component | Internal Reference | Official Docs |
|---|---|---|---|
| GitRepository | Source Controller | Local Docs | Official |
| HelmRepository | Source Controller | Local Docs | Official |
| HelmChart | Source Controller | Local Docs | Official |
| Bucket | Source Controller | Local Docs | Official |
| OCIRepository | Source Controller | Local Docs | Official |
| Kustomization | Kustomize Controller | Local Docs | Official |
| HelmRelease | Helm Controller | Local Docs | Official |
| Alert | Notification Controller | Local Docs | Official |
| Provider | Notification Controller | Local Docs | Official |
| Receiver | Notification Controller | Local Docs | Official |