v1alpha1

package
v0.3.0 Latest Latest
Warning

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

 Go to latest Published: Apr 15, 2024 License: BSD-3-Clause Imports: 5 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the stardog v1alpha1 API group +kubebuilder:object:generate=true +groupName=stardog.vshn.ch

Index

Constants

View Source 
const (
	// StardogReady tracks if the Stardog has been successfully reconciled.
	StardogReady StardogConditionType = "Ready"
	// StardogErrored is given when the object could not be reconciled with Stardog.
	StardogErrored StardogConditionType = "Errored"
	// StardogInvalid is given when the the object contains invalid properties. The object will not be further
	// reconciled until the issue is fixed.
	StardogInvalid StardogConditionType = "Invalid"
	// StardogTerminating is given when the the Stardog resource is to be deleted but the object's finalizers cannot
	// be cleared for a reason.
	StardogTerminating StardogConditionType = "StardogTerminating"

	ReasonFailed      = "SynchronizationFailed"
	ReasonSucceeded   = "SynchronizationSucceeded"
	ReasonSpecInvalid = "InvalidSpec"
	ReasonTerminating = "StardogTerminating"
)

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "stardog.vshn.ch", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

This section is empty.

Types

type StardogCondition 

type StardogCondition struct {
	Type               StardogConditionType   `json:"type"`
	Status             corev1.ConditionStatus `json:"status"`
	LastTransitionTime metav1.Time            `json:"lastTransitionTime,omitempty"`
	Reason             string                 `json:"reason,omitempty"`
	Message            string                 `json:"message,omitempty"`
}

StardogCondition describes a status condition of a StardogRole

func (*StardogCondition) DeepCopy 

func (in *StardogCondition) DeepCopy() *StardogCondition

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StardogCondition.

func (*StardogCondition) DeepCopyInto 

func (in *StardogCondition) DeepCopyInto(out *StardogCondition)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StardogConditionMap 

type StardogConditionMap map[StardogConditionType]StardogCondition

func (StardogConditionMap) DeepCopy 

func (in StardogConditionMap) DeepCopy() StardogConditionMap

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StardogConditionMap.

func (StardogConditionMap) DeepCopyInto 

func (in StardogConditionMap) DeepCopyInto(out *StardogConditionMap)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StardogConditionType 

type StardogConditionType string

type StardogInstance 

type StardogInstance struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   StardogInstanceSpec   `json:"spec,omitempty"`
	Status StardogInstanceStatus `json:"status,omitempty"`
}

StardogInstance contains information about a Stardog server or cluster.

func (*StardogInstance) DeepCopy 

func (in *StardogInstance) DeepCopy() *StardogInstance

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StardogInstance.

func (*StardogInstance) DeepCopyInto 

func (in *StardogInstance) DeepCopyInto(out *StardogInstance)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*StardogInstance) DeepCopyObject 

func (in *StardogInstance) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type StardogInstanceList 

type StardogInstanceList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []StardogInstance `json:"items"`
}

StardogInstanceList contains a list of StardogInstance

func (*StardogInstanceList) DeepCopy 

func (in *StardogInstanceList) DeepCopy() *StardogInstanceList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StardogInstanceList.

func (*StardogInstanceList) DeepCopyInto 

func (in *StardogInstanceList) DeepCopyInto(out *StardogInstanceList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*StardogInstanceList) DeepCopyObject 

func (in *StardogInstanceList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type StardogInstanceSpec 

type StardogInstanceSpec struct {
	// ServerUrl describes the url of the Stardog Instance
	// +kubebuilder:validation:Required
	ServerUrl string `json:"serverUrl,omitempty"`
	// AdminCredentials references the credentials that gives administrative access to the Stardog instance.
	// This is used by the Operator to make changes in the roles, permissions and users.
	// +kubebuilder:validation:Required
	AdminCredentials StardogUserCredentialsSpec `json:"adminCredentials,omitempty"`
	// Disabled whether this instance is disabled or enabled for operator to recycle resources
	Disabled bool `json:"disabled,omitempty"`
}

StardogInstanceSpec defines the desired state of StardogInstance

func (*StardogInstanceSpec) DeepCopy 

func (in *StardogInstanceSpec) DeepCopy() *StardogInstanceSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StardogInstanceSpec.

func (*StardogInstanceSpec) DeepCopyInto 

func (in *StardogInstanceSpec) DeepCopyInto(out *StardogInstanceSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StardogInstanceStatus 

type StardogInstanceStatus struct {
	// Conditions contain the states of the StardogInstance. A StardogInstance is considered Ready when the Admin user can make authorized REST API calls.
	Conditions []StardogCondition `json:"conditions,omitempty" patchStrategy:"merge"`
}

StardogInstanceStatus defines the observed state of StardogInstance

func (*StardogInstanceStatus) DeepCopy 

func (in *StardogInstanceStatus) DeepCopy() *StardogInstanceStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StardogInstanceStatus.

func (*StardogInstanceStatus) DeepCopyInto 

func (in *StardogInstanceStatus) DeepCopyInto(out *StardogInstanceStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StardogPermissionSpec 

type StardogPermissionSpec struct {
	// Action describes the action a specific permission is assigned to
	// +kubebuilder:validation:Enum=ALL;CREATE;DELETE;READ;WRITE;GRANT;REVOKE;EXECUTE
	// +kubebuilder:validation:Required
	Action string `json:"action,omitempty"`
	// ResourceType describes the type of resource a specific permission is assigned to
	// +kubebuilder:validation:Enum=DB;USER;ROLE;ADMIN;METADATA;NAMED-GRAPH;VIRTUAL-GRAPH;ICV-CONSTRAINTS;SENSITIVE-PROPERTIES;*
	// +kubebuilder:validation:Required
	ResourceType string `json:"resourceType,omitempty"`
	// Resources is a list of permission objects that get each targeted by the action and resource type properties
	// +kubebuilder:validation:Required
	Resources []string `json:"resources,omitempty"`
}

StardogPermissionSpec defines a Stardog permission assigned to a Role

func (*StardogPermissionSpec) DeepCopy 

func (in *StardogPermissionSpec) DeepCopy() *StardogPermissionSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StardogPermissionSpec.

func (*StardogPermissionSpec) DeepCopyInto 

func (in *StardogPermissionSpec) DeepCopyInto(out *StardogPermissionSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StardogRole 

type StardogRole struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   StardogRoleSpec   `json:"spec,omitempty"`
	Status StardogRoleStatus `json:"status,omitempty"`
}

StardogRole is the Schema for the stardogroles API

func (*StardogRole) DeepCopy 

func (in *StardogRole) DeepCopy() *StardogRole

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StardogRole.

func (*StardogRole) DeepCopyInto 

func (in *StardogRole) DeepCopyInto(out *StardogRole)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*StardogRole) DeepCopyObject 

func (in *StardogRole) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type StardogRoleList 

type StardogRoleList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []StardogRole `json:"items"`
}

StardogRoleList contains a list of StardogRole

func (*StardogRoleList) DeepCopy 

func (in *StardogRoleList) DeepCopy() *StardogRoleList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StardogRoleList.

func (*StardogRoleList) DeepCopyInto 

func (in *StardogRoleList) DeepCopyInto(out *StardogRoleList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*StardogRoleList) DeepCopyObject 

func (in *StardogRoleList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type StardogRoleSpec 

type StardogRoleSpec struct {
	// RoleName describes (overrides) the name of a role that will be maintained in a Stardog instance.
	// Defaults to .metadata.name.
	// +kubebuilder:validation:Optional
	RoleName string `json:"roleName,omitempty"`
	// StardogInstanceRef references the StardogInstance object in which the role is maintained.
	// +kubebuilder:validation:Required
	StardogInstanceRef string `json:"stardogInstanceRef,omitempty"`
	// Permissions lists the permissions assigned to a role
	// +kubebuilder:validation:Optional
	Permissions []StardogPermissionSpec `json:"permissions,omitempty"`
}

StardogRoleSpec defines the desired state of StardogRole

func (*StardogRoleSpec) DeepCopy 

func (in *StardogRoleSpec) DeepCopy() *StardogRoleSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StardogRoleSpec.

func (*StardogRoleSpec) DeepCopyInto 

func (in *StardogRoleSpec) DeepCopyInto(out *StardogRoleSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StardogRoleStatus 

type StardogRoleStatus struct {
	// Conditions contain the states of the StardogRole. A StardogRole is considered Ready when the role has been
	// persisted to Stardog DB.
	Conditions []StardogCondition `json:"conditions,omitempty" patchStrategy:"merge"`
}

StardogRoleStatus defines the observed state of StardogRole

func (*StardogRoleStatus) DeepCopy 

func (in *StardogRoleStatus) DeepCopy() *StardogRoleStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StardogRoleStatus.

func (*StardogRoleStatus) DeepCopyInto 

func (in *StardogRoleStatus) DeepCopyInto(out *StardogRoleStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StardogUser 

type StardogUser struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   StardogUserSpec   `json:"spec,omitempty"`
	Status StardogUserStatus `json:"status,omitempty"`
}

StardogUser is the Schema for the stardogusers API

func (*StardogUser) DeepCopy 

func (in *StardogUser) DeepCopy() *StardogUser

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StardogUser.

func (*StardogUser) DeepCopyInto 

func (in *StardogUser) DeepCopyInto(out *StardogUser)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*StardogUser) DeepCopyObject 

func (in *StardogUser) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type StardogUserCredentialsSpec 

type StardogUserCredentialsSpec struct {
	// Namespace specifies the namespace of the Secret referenced in SecretRef.
	// Defaults to .metadata.namespace.
	Namespace string `json:"namespace,omitempty"`
	// SecretRef references the v1/Secret name which contains the "username" and "password" keys.
	// +kubebuilder:validation:Required
	SecretRef string `json:"secretRef,omitempty"`
}

StardogUserCredentialsSpec specifies the password of a Stardog user

func (*StardogUserCredentialsSpec) DeepCopy 

func (in *StardogUserCredentialsSpec) DeepCopy() *StardogUserCredentialsSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StardogUserCredentialsSpec.

func (*StardogUserCredentialsSpec) DeepCopyInto 

func (in *StardogUserCredentialsSpec) DeepCopyInto(out *StardogUserCredentialsSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StardogUserList 

type StardogUserList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []StardogUser `json:"items"`
}

StardogUserList contains a list of StardogUser

func (*StardogUserList) DeepCopy 

func (in *StardogUserList) DeepCopy() *StardogUserList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StardogUserList.

func (*StardogUserList) DeepCopyInto 

func (in *StardogUserList) DeepCopyInto(out *StardogUserList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*StardogUserList) DeepCopyObject 

func (in *StardogUserList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type StardogUserSpec 

type StardogUserSpec struct {
	// StardogInstanceRef references a StardogInstance object.
	// +kubebuilder:validation:Required
	StardogInstanceRef string `json:"stardogInstanceRef,omitempty"`
	// StardogUserCredentialsSpec describes the credentials of a Stardog user
	// +kubebuilder:validation:Required
	Credentials StardogUserCredentialsSpec `json:"credentials,omitempty"`
	// Roles describe a list of StardogRoles assigned to a Stardog user. The names are referring the StardogRole metadata names, not the role name that is supposed to be in Stardog.
	// +kubebuilder:validation:Optional
	Roles []string `json:"roles,omitempty"`
}

StardogUserSpec defines the desired state of StardogUser

func (*StardogUserSpec) DeepCopy 

func (in *StardogUserSpec) DeepCopy() *StardogUserSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StardogUserSpec.

func (*StardogUserSpec) DeepCopyInto 

func (in *StardogUserSpec) DeepCopyInto(out *StardogUserSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StardogUserStatus 

type StardogUserStatus struct {
	// Conditions contain the states of the StardogUser. A StardogUser is considered Ready when the user has been
	// persisted to Stardog DB.
	Conditions []StardogCondition `json:"conditions,omitempty" patchStrategy:"merge"`
}

StardogUserStatus defines the observed state of StardogUser

func (*StardogUserStatus) DeepCopy 

func (in *StardogUserStatus) DeepCopy() *StardogUserStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StardogUserStatus.

func (*StardogUserStatus) DeepCopyInto 

func (in *StardogUserStatus) DeepCopyInto(out *StardogUserStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.