Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the synapse v1alpha1 API group +kubebuilder:object:generate=true +groupName=synapse.opdev.io
Index ¶
- Variables
- type Synapse
- type SynapseBridges
- type SynapseHeisenbridge
- type SynapseHeisenbridgeConfigMap
- type SynapseHomeserver
- type SynapseHomeserverConfigMap
- type SynapseHomeserverValues
- type SynapseList
- type SynapseMautrixSignal
- type SynapseMautrixSignalConfigMap
- type SynapseSpec
- type SynapseStatus
- type SynapseStatusDatabaseConnectionInfo
- type SynapseStatusHomeserverConfiguration
Constants ¶
This section is empty.
Variables ¶
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 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 ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Synapse.
func (*Synapse) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Synapse) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type SynapseBridges ¶
type SynapseBridges struct {
// Configuration options for the IRC bridge Heisenbridge. The user can
// either:
// * disable the deployment of the bridge.
// * 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.
Heisenbridge SynapseHeisenbridge `json:"heisenbridge,omitempty"`
// Configuration options for the mautrix-signal bridge. The user can
// either:
// * disable the deployment of the bridge.
// * 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.
MautrixSignal SynapseMautrixSignal `json:"mautrixSignal,omitempty"`
}
func (*SynapseBridges) DeepCopy ¶
func (in *SynapseBridges) DeepCopy() *SynapseBridges
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SynapseBridges.
func (*SynapseBridges) DeepCopyInto ¶
func (in *SynapseBridges) DeepCopyInto(out *SynapseBridges)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SynapseHeisenbridge ¶
type SynapseHeisenbridge struct {
// Whether to deploy Heisenbridge or not
Enabled bool `json:"enabled,omitempty"`
// 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 SynapseHeisenbridgeConfigMap `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"`
}
func (*SynapseHeisenbridge) DeepCopy ¶
func (in *SynapseHeisenbridge) DeepCopy() *SynapseHeisenbridge
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SynapseHeisenbridge.
func (*SynapseHeisenbridge) DeepCopyInto ¶
func (in *SynapseHeisenbridge) DeepCopyInto(out *SynapseHeisenbridge)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SynapseHeisenbridgeConfigMap ¶
type SynapseHeisenbridgeConfigMap 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 (*SynapseHeisenbridgeConfigMap) DeepCopy ¶
func (in *SynapseHeisenbridgeConfigMap) DeepCopy() *SynapseHeisenbridgeConfigMap
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SynapseHeisenbridgeConfigMap.
func (*SynapseHeisenbridgeConfigMap) DeepCopyInto ¶
func (in *SynapseHeisenbridgeConfigMap) DeepCopyInto(out *SynapseHeisenbridgeConfigMap)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
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 ¶
func (in *SynapseHomeserverConfigMap) DeepCopy() *SynapseHomeserverConfigMap
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SynapseHomeserverConfigMap.
func (*SynapseHomeserverConfigMap) DeepCopyInto ¶
func (in *SynapseHomeserverConfigMap) DeepCopyInto(out *SynapseHomeserverConfigMap)
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 ¶
func (in *SynapseHomeserverValues) DeepCopy() *SynapseHomeserverValues
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 SynapseMautrixSignal ¶ added in v0.2.0
type SynapseMautrixSignal struct {
// Whether to deploy mautrix-signal or not
Enabled bool `json:"enabled,omitempty"`
// 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 SynapseMautrixSignalConfigMap `json:"configMap,omitempty"`
}
func (*SynapseMautrixSignal) DeepCopy ¶ added in v0.2.0
func (in *SynapseMautrixSignal) DeepCopy() *SynapseMautrixSignal
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SynapseMautrixSignal.
func (*SynapseMautrixSignal) DeepCopyInto ¶ added in v0.2.0
func (in *SynapseMautrixSignal) DeepCopyInto(out *SynapseMautrixSignal)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type SynapseMautrixSignalConfigMap ¶ added in v0.2.0
type SynapseMautrixSignalConfigMap 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 (*SynapseMautrixSignalConfigMap) DeepCopy ¶ added in v0.2.0
func (in *SynapseMautrixSignalConfigMap) DeepCopy() *SynapseMautrixSignalConfigMap
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SynapseMautrixSignalConfigMap.
func (*SynapseMautrixSignalConfigMap) DeepCopyInto ¶ added in v0.2.0
func (in *SynapseMautrixSignalConfigMap) DeepCopyInto(out *SynapseMautrixSignalConfigMap)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
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"`
// Configuration options for optional matrix bridges
Bridges SynapseBridges `json:"bridges,omitempty"`
// Set to true to create a new PostreSQL instance. The homeserver.yaml
// 'database' section will be overwritten.
CreateNewPostgreSQL bool `json:"createNewPostgreSQL,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"`
// State of the Synapse instance
State string `json:"state,omitempty"`
// Reason for the current Synapse State
Reason string `json:"reason,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 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 ¶
func (in *SynapseStatusDatabaseConnectionInfo) DeepCopy() *SynapseStatusDatabaseConnectionInfo
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SynapseStatusDatabaseConnectionInfo.
func (*SynapseStatusDatabaseConnectionInfo) DeepCopyInto ¶
func (in *SynapseStatusDatabaseConnectionInfo) DeepCopyInto(out *SynapseStatusDatabaseConnectionInfo)
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 ¶
func (in *SynapseStatusHomeserverConfiguration) DeepCopy() *SynapseStatusHomeserverConfiguration
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SynapseStatusHomeserverConfiguration.
func (*SynapseStatusHomeserverConfiguration) DeepCopyInto ¶
func (in *SynapseStatusHomeserverConfiguration) DeepCopyInto(out *SynapseStatusHomeserverConfiguration)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.