persistence

Documentation

Index

• Constants
• type Account
• type Auth
• type AuthSecret
• type Environment
• type Group
• type Manifest
• type OAuth
• type Project
• type Type
• type TypedValue
  • func (c *TypedValue) UnmarshalYAML(unmarshal func(any) error) error

Constants

const GroupProjectType = "grouping"

const SimpleProjectType = "simple"

Types

type Account

type Account struct {
	Name        string      `` /* 132-byte string literal not displayed */
	AccountUUID TypedValue  `` /* 171-byte string literal not displayed */
	ApiUrl      *TypedValue `` /* 190-byte string literal not displayed */
	OAuth       OAuth       `` /* 128-byte string literal not displayed */
}

type Auth

type Auth struct {
	// Token defines an API access tokens used for Dynatrace Config API calls
	Token AuthSecret `yaml:"token" json:"token" jsonschema:"required,description=An API access tokens used for Dynatrace Config API calls."`
	// OAuth defines client credentials used for Dynatrace Platform API calls
	OAuth *OAuth `` /* 169-byte string literal not displayed */
}

Auth defines all required information for authenticated API calls

type AuthSecret

type AuthSecret struct {
	// Type exists for future compatibility - AuthSecrets are always read from 'environment' variables
	Type Type `yaml:"type" json:"type,omitempty"`
	//Name of the environment variable to read the secret from.
	Name string `yaml:"name" json:"name" jsonschema:"required"`
}

AuthSecret represents a user-defined client id or client secret. It has a Type which is TypeEnvironment (default). Secrets must never be provided as plain text, but always loaded from somewhere else. Currently, loading is only allowed from environment variables.

[Name] contains the environment-variable to resolve the authSecret.

This struct is meant to be reused for fields that require the same behavior.

type Environment

type Environment struct {
	Name string     `` /* 146-byte string literal not displayed */
	URL  TypedValue `yaml:"url" json:"url" jsonschema:"required,oneof_type=string;object,description=The URL of the environment."`

	Auth Auth `` /* 156-byte string literal not displayed */
}

Environment defines all required information for accessing a Dynatrace environment

type Group

type Group struct {
	Name         string        `` /* 139-byte string literal not displayed */
	Environments []Environment `` /* 131-byte string literal not displayed */
}

Group defines a group of Environment

type Manifest

type Manifest struct {
	ManifestVersion string `` /* 228-byte string literal not displayed */
	// Projects is a list of projects that will be deployed with this manifest
	Projects []Project `` /* 166-byte string literal not displayed */
	// EnvironmentGroups is a list of environment groups that configs in Projects will be deployed to
	EnvironmentGroups []Group `` /* 227-byte string literal not displayed */
	// Accounts is a list of accounts that account resources in Projects will be deployed to
	Accounts []Account `` /* 196-byte string literal not displayed */
}

type OAuth

type OAuth struct {
	// ClientID of the oAuth client credentials used to request bearer-tokens for authenticated API calls
	ClientID AuthSecret `` /* 163-byte string literal not displayed */
	// ClientSecret of the oAuth client credentials used to request bearer-tokens for authenticated API calls
	ClientSecret AuthSecret `` /* 175-byte string literal not displayed */
	// TokenEndpoint allows to optionally define a non-standard endpoint to request bearer-tokens from. Defaults to production sso.dynatrace.com if not defined.
	TokenEndpoint *TypedValue `` /* 215-byte string literal not displayed */
}

OAuth defines the required information to request oAuth bearer tokens for authenticated API calls

type Project

type Project struct {
	Name string `` /* 173-byte string literal not displayed */
	Type string `` /* 203-byte string literal not displayed */
	Path string `` /* 132-byte string literal not displayed */
}

type Type

type Type string

const (
	TypeEnvironment Type = "environment"
	TypeValue       Type = "value"
)

type TypedValue

type TypedValue struct {
	Type  Type   `` /* 214-byte string literal not displayed */
	Value string `` /* 188-byte string literal not displayed */
}

TypedValue represents a value with a Type - currently these are variables that can be either: - TypeEnvironment...loaded from an environment variable - TypeValue...read directly Additionally TypedValues can be defined directly as a string, as a shorthand for type: TypeValue

func (*TypedValue) UnmarshalYAML

func (c *TypedValue) UnmarshalYAML(unmarshal func(any) error) error

UnmarshalYAML Custom unmarshaler for TypedValue able to parse simple shorthands (accountUUID: 1234) and full values.