App SDK Concepts

# Latest version
go install github.com/grafana/grafana-app-sdk/cmd/grafana-app-sdk@latest

# Specific version
go install github.com/grafana/grafana-app-sdk/cmd/[email protected]

# Verify
grafana-app-sdk version

grafana-app-sdk project init <module-path>

grafana-app-sdk project kind add <KindName> [flags]

grafana-app-sdk project component add <component>

cmd/
└── operator/
    └── main.go          # operator entrypoint
pkg/
├── app/
│    └── app.go           # app.App implementation stub with TODOs
└── watchers/
    └── watcher_<kind>.go # <kind> watcher with stubbed methods

plugin/
├── src/
│   ├── module.ts
│   └── pages/
├── package.json
└── plugin.json

grafana-app-sdk generate [flags]

grafana-app-sdk generate yaml-bundle [flags]

# Start the local development environment
grafana-app-sdk local/up

// Codegen output configuration
config: {
    codegen: {
        // goModule allows explicitly setting the module path.
        // If empty the module path is read from go.mod
        // Default: ""
        goModule: ""
        // goModGenPath anchors generated Go output relative to the module root, instead of execution directory
        // Default: ""
        goModGenPath: ""
        // goGenPath sets the output directory for generated Go types.
        // Default: "pkg/generated/"
        goGenPath: "pkg/generated/"
        // tsGenPath sets the output directory for generated TypeScript types
        // Default: "plugin/src/generated/"
        tsGenPath: "plugin/src/generated/"
        // enableK8sPostProcessing runs the Kubernetes code generators after writing files.
        // This option is unnecessary when using the k8s.apiserver's DefaultAppInstaller
        // Default: false
        enableK8sPostProcessing: false
        // enableOperatorStatusGeneration toggles standard status information to be joined onto kinds' schema's status:
        // {
		//  #OperatorState: {
		// 	    // lastEvaluation is the ResourceVersion last evaluated
		// 	    lastEvaluation: string
		// 	    // state describes the state of the lastEvaluation.
		// 	    // It is limited to three possible states for machine evaluation.
		// 	    state: "success" | "in_progress" | "failed"
		// 	    // descriptiveState is an optional more descriptive state field which has no requirements on format
		// 	    descriptiveState?: string
		// 	    // details contains any extra information that is operator-specific
		// 	    details?: {
		// 		    [string]: _
		// 	    }
		//  }
		//  // operatorStates is a map of operator ID to operator state evaluations.
		//  // Any operator which consumes this kind SHOULD add its state evaluation information to this field.
		//  operatorStates?: {
		// 	    [string]: #OperatorState
		//  }
		//  // additionalFields is reserved for future use
		//  additionalFields?: {
		// 	    [string]: _
		//  }
	    // }
        // Default: true
        enableOperatorStatusGeneration: true
    }
    definitions: {
        // genManifest controls whether manifest files are written
        // Default: true
        genManifest: true
        // genCRDs controls whether CRD files are written
        // Default: true
        genCRDs: true
        // path sets where definition files are written
        // Default: "definitions"
        path: "definitions"
        // encoding determines JSON or YAML serialization of CRDs and manifest, allowed values are "json" and "yaml"
        // Default: "json"
        encoding: "json"
        // manifestVersion lets you pin the manifest schema format (legacy v1alpha1 vs default v1alpha2).
        // The v1alpha1 manifest uses CRD-compatible schemas for kinds, the v1alpha2 version contains more information but requires transformation to make kind schemas CRD-compatible.
        // Default: "v1alpha2"
        manifestVersion: "v1alpha2"
    }
}

export PATH="$PATH:$(go env GOPATH)/bin"

go mod tidy