v1alpha1

package
v0.5.1 Latest Latest
Warning

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

Go to latest
Published: May 5, 2023 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the synapse v1alpha1 API group +kubebuilder:object:generate=true +groupName=synapse.opdev.io

Index

Constants

This section is empty.

Variables

View Source
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "synapse.opdev.io", 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 Heisenbridge added in v0.3.0

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

	// +kubebuilder:validation:Required
	Spec   HeisenbridgeSpec   `json:"spec"`
	Status HeisenbridgeStatus `json:"status,omitempty"`
}

Heisenbridge is the Schema for the heisenbridges API

func (*Heisenbridge) DeepCopy added in v0.3.0

func (in *Heisenbridge) DeepCopy() *Heisenbridge

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

func (*Heisenbridge) DeepCopyInto added in v0.3.0

func (in *Heisenbridge) DeepCopyInto(out *Heisenbridge)

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

func (*Heisenbridge) DeepCopyObject added in v0.3.0

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

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

func (*Heisenbridge) GetSynapseName added in v0.5.0

func (h *Heisenbridge) GetSynapseName() string

func (*Heisenbridge) GetSynapseNamespace added in v0.5.0

func (h *Heisenbridge) GetSynapseNamespace() string

type HeisenbridgeConfigMap added in v0.3.0

type HeisenbridgeConfigMap struct {

	// Name of the ConfigMap in the given Namespace.
	Name string `json:"name"`

	// Namespace in which the ConfigMap is living. If left empty, the
	// Heisenbridge namespace is used.
	Namespace string `json:"namespace,omitempty"`
}

func (*HeisenbridgeConfigMap) DeepCopy added in v0.3.0

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

func (*HeisenbridgeConfigMap) DeepCopyInto added in v0.3.0

func (in *HeisenbridgeConfigMap) DeepCopyInto(out *HeisenbridgeConfigMap)

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

type HeisenbridgeList added in v0.3.0

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

HeisenbridgeList contains a list of Heisenbridge

func (*HeisenbridgeList) DeepCopy added in v0.3.0

func (in *HeisenbridgeList) DeepCopy() *HeisenbridgeList

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

func (*HeisenbridgeList) DeepCopyInto added in v0.3.0

func (in *HeisenbridgeList) DeepCopyInto(out *HeisenbridgeList)

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

func (*HeisenbridgeList) DeepCopyObject added in v0.3.0

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

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

type HeisenbridgeSpec added in v0.3.0

type HeisenbridgeSpec struct {
	// Holds information about the ConfigMap containing the heisenbridge.yaml
	// configuration file to be used as input for the configuration of the
	// Heisenbridge IRC Bridge.
	ConfigMap HeisenbridgeConfigMap `json:"configMap,omitempty"`

	// Controls the verbosity of the Heisenbrige:
	// * 0 corresponds to normal level of logs
	// * 1 corresponds to "-v"
	// * 2 corresponds to "-vv"
	// * 3 corresponds to "-vvv"
	VerboseLevel int `json:"verboseLevel,omitempty"`

	// Name of the Synapse instance, living in the same namespace.
	Synapse HeisenbridgeSynapseSpec `json:"synapse"`
}

HeisenbridgeSpec defines the desired state of Heisenbridge. The user can either:

  • enable the bridge, without specifying additional configuration options. The bridge will be deployed with a default configuration.
  • enable the bridge and specify an existing ConfigMap by its Name and Namespace containing a heisenbridge.yaml.

func (*HeisenbridgeSpec) DeepCopy added in v0.3.0

func (in *HeisenbridgeSpec) DeepCopy() *HeisenbridgeSpec

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

func (*HeisenbridgeSpec) DeepCopyInto added in v0.3.0

func (in *HeisenbridgeSpec) DeepCopyInto(out *HeisenbridgeSpec)

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

type HeisenbridgeStatus added in v0.3.0

type HeisenbridgeStatus struct {
	// State of the Heisenbridge instance
	State string `json:"state,omitempty"`

	// Reason for the current Heisenbridge State
	Reason string `json:"reason,omitempty"`
}

HeisenbridgeStatus defines the observed state of Heisenbridge

func (*HeisenbridgeStatus) DeepCopy added in v0.3.0

func (in *HeisenbridgeStatus) DeepCopy() *HeisenbridgeStatus

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

func (*HeisenbridgeStatus) DeepCopyInto added in v0.3.0

func (in *HeisenbridgeStatus) DeepCopyInto(out *HeisenbridgeStatus)

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

type HeisenbridgeSynapseSpec added in v0.3.0

type HeisenbridgeSynapseSpec struct {

	// Name of the Synapse instance
	Name string `json:"name"`

	// Namespace of the Synapse instance
	// TODO: Complete
	Namespace string `json:"namespace,omitempty"`
}

func (*HeisenbridgeSynapseSpec) DeepCopy added in v0.3.0

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

func (*HeisenbridgeSynapseSpec) DeepCopyInto added in v0.3.0

func (in *HeisenbridgeSynapseSpec) DeepCopyInto(out *HeisenbridgeSynapseSpec)

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

type MautrixSignal added in v0.3.0

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

	// +kubebuilder:validation:Required
	Spec   MautrixSignalSpec   `json:"spec"`
	Status MautrixSignalStatus `json:"status,omitempty"`
}

MautrixSignal is the Schema for the mautrixsignals API

func (*MautrixSignal) DeepCopy added in v0.3.0

func (in *MautrixSignal) DeepCopy() *MautrixSignal

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

func (*MautrixSignal) DeepCopyInto added in v0.3.0

func (in *MautrixSignal) DeepCopyInto(out *MautrixSignal)

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

func (*MautrixSignal) DeepCopyObject added in v0.3.0

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

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

func (*MautrixSignal) GetSynapseName added in v0.5.0

func (ms *MautrixSignal) GetSynapseName() string

func (*MautrixSignal) GetSynapseNamespace added in v0.5.0

func (ms *MautrixSignal) GetSynapseNamespace() string

type MautrixSignalConfigMap added in v0.3.0

type MautrixSignalConfigMap struct {

	// Name of the ConfigMap in the given Namespace.
	Name string `json:"name"`

	// Namespace in which the ConfigMap is living. If left empty, the Synapse
	// namespace is used.
	Namespace string `json:"namespace,omitempty"`
}

func (*MautrixSignalConfigMap) DeepCopy added in v0.3.0

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

func (*MautrixSignalConfigMap) DeepCopyInto added in v0.3.0

func (in *MautrixSignalConfigMap) DeepCopyInto(out *MautrixSignalConfigMap)

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

type MautrixSignalList added in v0.3.0

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

MautrixSignalList contains a list of MautrixSignal

func (*MautrixSignalList) DeepCopy added in v0.3.0

func (in *MautrixSignalList) DeepCopy() *MautrixSignalList

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

func (*MautrixSignalList) DeepCopyInto added in v0.3.0

func (in *MautrixSignalList) DeepCopyInto(out *MautrixSignalList)

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

func (*MautrixSignalList) DeepCopyObject added in v0.3.0

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

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

type MautrixSignalSpec added in v0.3.0

type MautrixSignalSpec struct {
	// Holds information about the ConfigMap containing the config.yaml
	// configuration file to be used as input for the configuration of the
	// mautrix-signal bridge.
	ConfigMap MautrixSignalConfigMap `json:"configMap,omitempty"`

	// Name of the Synapse instance, living in the same namespace.
	Synapse MautrixSignalSynapseSpec `json:"synapse"`
}

MautrixSignalSpec defines the desired state of MautrixSignal. The user can either:

  • enable the bridge, without specifying additional configuration options. The bridge will be deployed with a default configuration.
  • enable the bridge and specify an existing ConfigMap by its Name and Namespace containing a config.yaml file.

func (*MautrixSignalSpec) DeepCopy added in v0.3.0

func (in *MautrixSignalSpec) DeepCopy() *MautrixSignalSpec

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

func (*MautrixSignalSpec) DeepCopyInto added in v0.3.0

func (in *MautrixSignalSpec) DeepCopyInto(out *MautrixSignalSpec)

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

type MautrixSignalStatus added in v0.3.0

type MautrixSignalStatus struct {
	// State of the MautrixSignal instance
	State string `json:"state,omitempty"`

	// Reason for the current MautrixSignal State
	Reason string `json:"reason,omitempty"`

	// Information related to the Synapse instance associated with this bridge
	Synapse MautrixSignalStatusSynapse `json:"synapse,omitempty"`

	// Values is set to true if deploying on OpenShift
	IsOpenshift bool `json:"isOpenshift,omitempty"`
}

MautrixSignalStatus defines the observed state of MautrixSignal

func (*MautrixSignalStatus) DeepCopy added in v0.3.0

func (in *MautrixSignalStatus) DeepCopy() *MautrixSignalStatus

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

func (*MautrixSignalStatus) DeepCopyInto added in v0.3.0

func (in *MautrixSignalStatus) DeepCopyInto(out *MautrixSignalStatus)

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

type MautrixSignalStatusSynapse added in v0.3.0

type MautrixSignalStatusSynapse struct {
	ServerName string `json:"serverName,omitempty"`
}

func (*MautrixSignalStatusSynapse) DeepCopy added in v0.3.0

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

func (*MautrixSignalStatusSynapse) DeepCopyInto added in v0.3.0

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

type MautrixSignalSynapseSpec added in v0.3.0

type MautrixSignalSynapseSpec struct {

	// Name of the Synapse instance
	Name string `json:"name"`

	// Namespace of the Synapse instance
	// TODO: Complete
	Namespace string `json:"namespace,omitempty"`
}

func (*MautrixSignalSynapseSpec) DeepCopy added in v0.3.0

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

func (*MautrixSignalSynapseSpec) DeepCopyInto added in v0.3.0

func (in *MautrixSignalSynapseSpec) DeepCopyInto(out *MautrixSignalSynapseSpec)

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

type Synapse

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

	// +kubebuilder:validation:Required
	Spec   SynapseSpec   `json:"spec"`
	Status SynapseStatus `json:"status,omitempty"`
}

Synapse is the Schema for the synapses API

func (*Synapse) DeepCopy

func (in *Synapse) DeepCopy() *Synapse

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

func (*Synapse) DeepCopyInto

func (in *Synapse) DeepCopyInto(out *Synapse)

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

func (*Synapse) DeepCopyObject

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

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

type SynapseHomeserver

type SynapseHomeserver struct {
	// Holds information about the ConfigMap containing the homeserver.yaml
	// configuration file to be used as input for the configuration of the
	// Synapse server.
	ConfigMap *SynapseHomeserverConfigMap `json:"configMap,omitempty"`

	// Holds the required values for the creation of a homeserver.yaml
	// configuration file by the Synapse Operator
	Values *SynapseHomeserverValues `json:"values,omitempty"`
}

func (*SynapseHomeserver) DeepCopy

func (in *SynapseHomeserver) DeepCopy() *SynapseHomeserver

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

func (*SynapseHomeserver) DeepCopyInto

func (in *SynapseHomeserver) DeepCopyInto(out *SynapseHomeserver)

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

type SynapseHomeserverConfigMap

type SynapseHomeserverConfigMap struct {

	// Name of the ConfigMap in the given Namespace.
	Name string `json:"name"`

	// Namespace in which the ConfigMap is living. If left empty, the Synapse
	// namespace is used.
	Namespace string `json:"namespace,omitempty"`
}

func (*SynapseHomeserverConfigMap) DeepCopy

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

func (*SynapseHomeserverConfigMap) DeepCopyInto

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

type SynapseHomeserverValues

type SynapseHomeserverValues struct {

	// The public-facing domain of the server
	ServerName string `json:"serverName"`

	// Whether or not to report anonymized homeserver usage statistics
	ReportStats bool `json:"reportStats"`
}

func (*SynapseHomeserverValues) DeepCopy

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

func (*SynapseHomeserverValues) DeepCopyInto

func (in *SynapseHomeserverValues) DeepCopyInto(out *SynapseHomeserverValues)

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

type SynapseList

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

SynapseList contains a list of Synapse

func (*SynapseList) DeepCopy

func (in *SynapseList) DeepCopy() *SynapseList

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

func (*SynapseList) DeepCopyInto

func (in *SynapseList) DeepCopyInto(out *SynapseList)

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

func (*SynapseList) DeepCopyObject

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

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

type SynapseSpec

type SynapseSpec struct {

	// Holds information related to the homeserver.yaml configuration file.
	// The user can either specify an existing ConfigMap by its Name and
	// Namespace containing a homeserver.yaml, or provide a set of values for
	// the creation of a configuration file from scratch.
	Homeserver SynapseHomeserver `json:"homeserver"`

	// Set to true to create a new PostreSQL instance. The homeserver.yaml
	// 'database' section will be overwritten.
	CreateNewPostgreSQL bool `json:"createNewPostgreSQL,omitempty"`

	// Set to true if deploying on OpenShift
	IsOpenshift bool `json:"isOpenshift,omitempty"`
}

SynapseSpec defines the desired state of Synapse

func (*SynapseSpec) DeepCopy

func (in *SynapseSpec) DeepCopy() *SynapseSpec

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

func (*SynapseSpec) DeepCopyInto

func (in *SynapseSpec) DeepCopyInto(out *SynapseSpec)

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

type SynapseStatus

type SynapseStatus struct {

	// Connection information to the external PostgreSQL Database
	DatabaseConnectionInfo SynapseStatusDatabaseConnectionInfo `json:"databaseConnectionInfo,omitempty"`

	// Holds configuration information for Synapse
	HomeserverConfiguration SynapseStatusHomeserverConfiguration `json:"homeserverConfiguration,omitempty"`

	// Information on the bridges deployed alongside Synapse
	Bridges SynapseStatusBridges `json:"bridges,omitempty"`

	// State of the Synapse instance
	State string `json:"state,omitempty"`

	// Reason for the current Synapse State
	Reason string `json:"reason,omitempty"`

	// +kubebuilder:default:=false
	NeedsReconcile bool `json:"needsReconcile,omitempty"`
}

SynapseStatus defines the observed state of Synapse

func (*SynapseStatus) DeepCopy

func (in *SynapseStatus) DeepCopy() *SynapseStatus

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

func (*SynapseStatus) DeepCopyInto

func (in *SynapseStatus) DeepCopyInto(out *SynapseStatus)

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

type SynapseStatusBridges added in v0.3.0

type SynapseStatusBridges struct {
	// Information on the Heisenbridge (IRC Bridge).
	Heisenbridge SynapseStatusBridgesHeisenbridge `json:"heisenbridge,omitempty"`

	// Information on the mautrix-signal bridge.
	MautrixSignal SynapseStatusBridgesMautrixSignal `json:"mautrixsignal,omitempty"`
}

func (*SynapseStatusBridges) DeepCopy added in v0.3.0

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

func (*SynapseStatusBridges) DeepCopyInto added in v0.3.0

func (in *SynapseStatusBridges) DeepCopyInto(out *SynapseStatusBridges)

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

type SynapseStatusBridgesHeisenbridge added in v0.3.0

type SynapseStatusBridgesHeisenbridge struct {

	// Whether a Heisenbridge has been deployed for this Synapse instance
	Enabled bool `json:"enabled,omitempty"`

	// Name of the Heisenbridge object
	Name string `json:"name,omitempty"`
}

func (*SynapseStatusBridgesHeisenbridge) DeepCopy added in v0.3.0

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

func (*SynapseStatusBridgesHeisenbridge) DeepCopyInto added in v0.3.0

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

type SynapseStatusBridgesMautrixSignal added in v0.3.0

type SynapseStatusBridgesMautrixSignal struct {
	// Whether a mautrix-signal has been deployed for this Synapse instance
	Enabled bool `json:"enabled,omitempty"`

	// Name of the mautrix-signal bridge object
	Name string `json:"name,omitempty"`
}

func (*SynapseStatusBridgesMautrixSignal) DeepCopy added in v0.3.0

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

func (*SynapseStatusBridgesMautrixSignal) DeepCopyInto added in v0.3.0

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

type SynapseStatusDatabaseConnectionInfo

type SynapseStatusDatabaseConnectionInfo struct {
	// Endpoint to connect to the PostgreSQL database
	ConnectionURL string `json:"connectionURL,omitempty"`

	// Name of the database to connect to
	DatabaseName string `json:"databaseName,omitempty"`

	// User allowed to query the given database
	User string `json:"user,omitempty"`

	// Base64 encoded password
	Password string `json:"password,omitempty"`

	// State of the PostgreSQL database
	State string `json:"State,omitempty"`
}

func (*SynapseStatusDatabaseConnectionInfo) DeepCopy

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

func (*SynapseStatusDatabaseConnectionInfo) DeepCopyInto

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

type SynapseStatusHomeserverConfiguration

type SynapseStatusHomeserverConfiguration struct {
	// The public-facing domain of the server
	ServerName string `json:"serverName,omitempty"`

	// Whether or not to report anonymized homeserver usage statistics
	ReportStats bool `json:"reportStats,omitempty"`
}

func (*SynapseStatusHomeserverConfiguration) DeepCopy

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

func (*SynapseStatusHomeserverConfiguration) DeepCopyInto

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL