package
0.0.0-20211220131229-8c8647d81953
Repository: https://github.com/viaq/loki-operator.git
Documentation: pkg.go.dev
# Constants
ConditionDegraded defines the condition that some or all components in the Loki deployment are degraded or the cluster cannot connect to object storage.
ConditionFailed defines the condition that components in the Loki deployment failed to roll out.
ConditionPending defines the conditioin that some or all components are in pending state.
ConditionReady defines the condition that all components in the Loki deployment are ready.
Dynamic mode delegates the authorization to a third-party OPA-compatible endpoint.
Group represents a subject that is a group.
ManagementStateManaged when the LokiStack custom resource should be reconciled by the operator.
ManagementStateUnmanaged when the LokiStack custom resource should not be reconciled by the operator.
OpenshiftLogging mode provides fully automatic OpenShift in-cluster authentication and authorization support.
Read gives access to read data from a tenant.
ReasonFailedComponents when all/some LokiStack components fail to roll out.
ReasonInvalidGatewayTenantSecret when the format of the secret is invalid.
ReasonInvalidObjectStorageSecret when the format of the secret is invalid.
ReasonInvalidReplicationConfiguration when the configurated replication factor is not valid with the select cluster size.
ReasonInvalidTenantsConfiguration when the tenant configuration provided is invalid.
ReasonMissingGatewayOpenShiftBaseDomain when the reconciler cannot lookup the OpenShift DNS base domain.
ReasonMissingGatewayTenantSecret when the required tenant secret for authentication is missing.
ReasonMissingObjectStorageSecret when the required secret to store logs to object storage is missing.
ReasonPendingComponents when all/some LokiStack components pending dependencies.
ReasonReadyComponents when all LokiStack components are ready to serve traffic.
SizeOneXExtraSmall defines the size of a single Loki deployment with extra small resources/limits requirements and without HA support.
SizeOneXMedium defines the size of a single Loki deployment with small resources/limits requirements and HA support for all Loki components.
SizeOneXSmall defines the size of a single Loki deployment with small resources/limits requirements and HA support for all Loki components.
Static mode asserts the Authorization Spec's Roles and RoleBindings using an in-process OpenPolicyAgent Rego authorizer.
User represents a subject that is a user.
Write gives access to write data to a tenant.
# Variables
AddToScheme adds the types in this group-version to the given scheme.
GroupVersion is group version used to register these objects.
SchemeBuilder is used to add go types to the GroupVersionKind scheme.
# Structs
AuthenticationSpec defines the oidc configuration per tenant for lokiStack Gateway component.
AuthorizationSpec defines the opa, role bindings and roles configuration per tenant for lokiStack Gateway component.
IngestionLimitSpec defines the limits applied at the ingestion path.
LimitsSpec defines the spec for limits applied at ingestion or query path across the cluster or per tenant.
LimitsTemplateSpec defines the limits applied at ingestion or query path.
LokiComponentSpec defines the requirements to configure scheduling of each loki component individually.
LokiStack is the Schema for the lokistacks API
+operator-sdk:csv:customresourcedefinitions:displayName="LokiStack",resources={{Deployment,v1},{StatefulSet,v1},{ConfigMap,v1},{Ingress,v1},{Service,v1},{ServiceAccount,v1},{PersistentVolumeClaims,v1},{Route,v1},{ServiceMonitor,v1}}.
LokiStackComponentStatus defines the map of per pod status per LokiStack component.
LokiStackList contains a list of LokiStack.
LokiStackSpec defines the desired state of LokiStack.
LokiStackStatus defines the observed state of LokiStack.
LokiTemplateSpec defines the template of all requirements to configure scheduling of all Loki components to be deployed.
ObjectStorageSecretSpec is a secret reference containing name only, no namespace.
ObjectStorageSpec defines the requirements to access the object storage bucket to persist logs by the ingester component.
OIDCSpec defines the oidc configuration spec for lokiStack Gateway component.
OPASpec defines the opa configuration spec for lokiStack Gateway component.
QueryLimitSpec defines the limits applies at the query path.
RoleBindingsSpec binds a set of roles to a set of subjects.
RoleSpec describes a set of permissions to interact with a tenant.
Subject represents a subject that has been bound to a role.
TenantSecretSpec is a secret reference containing name only for a secret living in the same namespace as the LokiStack custom resource.
TenantsSpec defines the mode, authentication and authorization configuration of the lokiStack gateway component.
# Type aliases
LokiStackConditionReason defines the type for valid reasons of a Loki deployment conditions.
LokiStackConditionType deifnes the type of condition types of a Loki deployment.
LokiStackSizeType declares the type for loki cluster scale outs.
ManagementStateType defines the type for CR management states.
ModeType is the authentication/authorization mode in which LokiStack Gateway will be configured.
PermissionType is a LokiStack Gateway RBAC permission.
PodStatusMap defines the type for mapping pod status to pod name.
SubjectKind is a kind of LokiStack Gateway RBAC subject.