Managed Grafana

1 resource kind. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

GrafanaWorkspace # GA

GrafanaWorkspace is the Schema for managing Amazon Managed Grafana workspaces.

kubectl get grafanaworkspaces · example on GitHub

Example

# GrafanaWorkspace — Managed Grafana
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/grafana.html#grafanaworkspace
apiVersion: aws.konfig.io/v1alpha1
kind: GrafanaWorkspace
metadata:
  name: example-grafanaworkspace
  namespace: default
spec:
  accountAccessType: CURRENT_ACCOUNT
  authenticationProviders:
  - example
  dataSources:
  - example
  grafanaVersion: '1.0'
  permissionType: SERVICE_MANAGED
  providerRef:
    name: example-grafanaworkspace
    region: us-east-1
  tags:
    environment: dev
    team: platform
  workspaceName: example-grafanaworkspace
  workspaceRoleRef:
    name: example-workspacerole

Spec

Field	Type	Required	Description
`accountAccessType`	enum	yes	AccountAccessType specifies whether the workspace accesses AWS resources in this account only or across an organization. Allowed: `CURRENT_ACCOUNT, ORGANIZATION`
`authenticationProviders`	array<string>	yes	AuthenticationProviders lists the user authentication methods.
`dataSources`	array<string>	—	DataSources lists AWS data sources the workspace can access, e.g.
`grafanaVersion`	string	—	GrafanaVersion is the Grafana version for the workspace (e.g.
`permissionType`	enum	yes	PermissionType is SERVICE_MANAGED or CUSTOMER_MANAGED. Allowed: `SERVICE_MANAGED, CUSTOMER_MANAGED`
`providerRef`	object	—	ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
`providerRef.name`	string	yes	Name of a cluster-scoped AWSProvider.
`providerRef.region`	string	—	Region overrides the provider's region for this resource only.
`tags`	map<string>	—	Tags are AWS resource tags to apply at creation time.
`workspaceName`	string	yes	WorkspaceName is the name of the workspace.
`workspaceRoleRef`	object	—	WorkspaceRoleRef references the IAM role that the workspace uses to access AWS data sources and notification channels, either a managed IAMRole CR (name) or a direct role ARN (arn).
`workspaceRoleRef.arn`	string	—	ARN is a direct AWS IAM role ARN.
`workspaceRoleRef.name`	string	—	Name of an IAMRole CR in the same namespace.
`workspaceRoleRef.namespace`	string	—	Namespace of the IAMRole CR.

Status

Field	Type	Required	Description
`awsProvider`	object	—	AWSProvider confirms the account and region this resource was reconciled against.
`awsProvider.accountId`	string	—	AccountID the resource lives in.
`awsProvider.name`	string	—	Name of the AWSProvider used; empty when the operator's own credentials were used.
`awsProvider.region`	string	—	Region the resource lives in (empty for global services).
`conditions`	array<object>	—	Conditions describe the current state of the resource.
`conditions[].lastTransitionTime`	string	yes	lastTransitionTime is the last time the condition transitioned from one status to another.
`conditions[].message`	string	yes	message is a human readable message indicating details about the transition.
`conditions[].observedGeneration`	integer	—	observedGeneration represents the .metadata.generation that the condition was set based upon.
`conditions[].reason`	string	yes	reason contains a programmatic identifier indicating the reason for the condition's last transition.
`conditions[].status`	enum	yes	status of the condition, one of True, False, Unknown. Allowed: `True, False, Unknown`
`conditions[].type`	string	yes	type of condition in CamelCase or in foo.example.com/CamelCase.
`endpoint`	string	—	Endpoint is the URL of the Grafana console for the workspace.
`grafanaVersion`	string	—	GrafanaVersion is the Grafana version running in the workspace.
`lastSyncTime`	string	—	LastSyncTime is when the resource was last successfully reconciled.
`observedGeneration`	integer	—	ObservedGeneration is the most recent .metadata.generation reconciled.
`status`	string	—	Status is the current AWS status of the workspace (CREATING, ACTIVE, ...).
`workspaceId`	string	—	WorkspaceID is the unique ID of the workspace (g-...).