cli

package
v0.7.9 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 3, 2026 License: Apache-2.0 Imports: 50 Imported by: 0

README

cmd/cli

CLI command definitions for the ork binary. Each file registers one command or sub-command with the root Cobra command.

Entry points

Command File What it does
ork run run.go / run_dev.go Start the runtime (reconcile loop)
ork gate gate.go Start the gateway (TLS + webhooks, cluster-only)
ork generate generate.go Generate RBAC, bundles, ConfigMaps, CRDs, docs
ork validate validate.go Validate an Orkestra Pattern
ork plan plan.go Dry-run a Katalog against a live cluster

For the full command reference see documentation/reference/cli.

Design docs

  • build-tags.md — how //go:build runtime and //go:build gateway control which sub-commands ship in each image

Documentation

Index

Constants

View Source
const (
	SchemaRefKatalog       = "https://orkestra.sh/docs/reference/schema/katalog/"
	SchemaRefKomposer      = "https://orkestra.sh/docs/reference/schema/komposer/"
	SchemaRefMotif         = "https://orkestra.sh/docs/reference/schema/motif/"
	SchemaRefE2E           = "https://orkestra.sh/docs/reference/schema/e2e/"
	SchemaRefE2EImports    = "https://orkestra.sh/docs/reference/schema/e2e/imports/"
	SchemaRefSimulate      = "https://orkestra.sh/docs/reference/schema/simulate/"
	SchemaRefSimulateSuite = "https://orkestra.sh/docs/reference/schema/simulate/#aggregator-form"
)

Variables

View Source
var Packs = map[string]Pack{
	"beginner": {
		Name:        "beginner",
		Description: "Start here. Simple CRDs, Deployments, Services.",
		Path:        "beginner",
		Order:       1,
	},
	"intermediate": {
		Name:        "intermediate",
		Description: "Multi-resource patterns, when/anyOf, Komposer basics.",
		Path:        "intermediate",
		Order:       2,
	},
	"advanced": {
		Name:        "advanced",
		Description: "Hooks, constructors, validation/mutation, registries.",
		Path:        "advanced",
		Order:       3,
	},
	"security": {
		Name:        "security",
		Description: "Deletion protection, namespace protection, admission webhooks.",
		Path:        "security",
		Order:       4,
	},
	"resilience": {
		Name:        "resilience",
		Description: "Operators that stay running — panic recovery, degraded state, isolation.",
		Path:        "resilience",
		Order:       5,
	},
	"use-cases": {
		Name:        "use-cases",
		Description: "Full-stack, cross-CRD, external gates, once-secrets.",
		Path:        "use-cases",
		Order:       6,
	},
	"registry-guide": {
		Name:        "registry-guide",
		Description: "End-to-end registry workflow: consume, build motifs, publish, compose, upgrade, deprecate, typed operators, CI.",
		Path:        "registry-guide",
		Order:       7,
	},
	"ecosystem-composition": {
		Name:        "ecosystem-composition",
		Description: "Wrap ArgoCD, cert-manager, Prometheus Operator, and Crossplane behind internal CRDs.",
		Path:        "ecosystem-composition",
		Order:       8,
	},
	"from-controller-runtime": {
		Name:        "from-controller-runtime",
		Description: "Migrate an existing controller-runtime operator to Orkestra: declarative, hooks, or constructor.",
		Path:        "from-controller-runtime",
		Order:       9,
	},
}

Functions

func Execute

func Execute(k *konfig.Konfig, c context.Context)

func StartSpinner added in v0.4.8

func StartSpinner(msg string) *utils.Spinner

StartSpinner starts a terminal progress spinner with the given message. Call Success, Failure, or Stop on the returned value when done.

Types

type Pack added in v0.3.8

type Pack struct {
	Name        string
	Description string
	Path        string
	Order       int // for sorting in --list
}

packPaths maps CLI pack names to their paths inside the embedded FS. Most packs are top-level directories; rollback is nested under use-cases.

func GetPack added in v0.3.8

func GetPack(name string) (Pack, bool)

func ListPacks added in v0.3.8

func ListPacks() []Pack

func (Pack) String added in v0.5.1

func (p Pack) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL