model

type DesiredState struct {
	// Extensions is a list of Postgres extensions (e.g. postgres_fdw)
	Extensions []Extension `yaml:"Extensions,omitempty" json:"Extensions,omitempty"`
	// Servers is a list of foreign servers
	Servers []ForeignServer `yaml:"Servers,omitempty" json:"Servers,omitempty"`
}

type Extension struct {
	Name    string `yaml:"name" json:"name"`
	Version string `yaml:"-" json:"-"`
}

type ForeignServer struct {
	// Name is the display name of the foreign server
	Name string `yaml:"name" json:"name"`
	// Host is the hostname of the foreign server
	Host string `yaml:"host" json:"host"`
	// Port is the port number of the foreign server
	Port int `yaml:"port" json:"port"`
	// DB is the name of the database on the foreign server
	DB string `yaml:"db" json:"db"`
	// Wrapper is the name of the foreign data wrapper to use with this foreign server
	Wrapper string `yaml:"wrapper,omitempty" json:"wrapper,omitempty"`
	// Owner is the owner of the foreign server
	Owner string `yaml:"-" json:"-"`
	// UserMaps is the list of user mappings to create using this foreign server
	UserMaps []UserMap `yaml:"UserMap,omitempty" json:"UserMap,omitempty"`
	// Schemas is the list of remote schemas to import from this foreign server
	Schemas []Schema `yaml:"Schemas,omitempty" json:"Schemas,omitempty"`
}

type Grants struct {
	// Users is the list of users to apply the permissions to
	Users []string `yaml:"users" json:"users"`
}

type Schema struct {
	// ServerName is the name of the foreign server that will be used to import the remote schema
	ServerName string `yaml:"-" json:"-"`
	// LocalSchema is the name of the local schema that the remote schema will be imported into
	LocalSchema string `yaml:"localschema" json:"localschema"`
	// RemoteSchema is the name of the remote schema to import
	RemoteSchema string `yaml:"remoteschema" json:"remoteschema"`
	// ImportENUMs indicates whether remote ENUM types should be auto-created locally before importing
	ImportENUMs bool `yaml:"importenums" json:"importenums"`
	// ENUMConnection specifies the connection string to the remote database for reading ENUM definitions
	ENUMConnection string `yaml:"enumconnection,omitempty" json:"enumconnection,omitempty"`
	// ENUMSecret configures how to retrieve the optional credential for the ENUMConnection connection string
	ENUMSecret Secret `yaml:"enumsecret,omitempty" json:"enumsecret,omitempty"`
	// SchemaGrants is the permission configuration for this foreign schema
	SchemaGrants Grants `yaml:"grants,omitempty" json:"grants,omitempty"`
}

type Secret struct {
	// Value represents an explicit credential value to be used verbatim
	Value string `yaml:"value,omitempty" json:"value,omitempty"`
	// FromEnv represents an environment variable to read the credential from
	FromEnv string `yaml:"fromEnv,omitempty" json:"fromEnv,omitempty"`
	// FromFile represents a path and filename to read the credential from
	FromFile string `yaml:"fromFile,omitempty" json:"fromFile,omitempty"`
	// FromK8sSecret represents a Kubernetes secret to read the credential from
	FromK8sSecret SecretK8s `yaml:"fromK8s,omitempty" json:"fromK8s,omitempty"`
}

type SecretK8s struct {
	// Namespace is the Kubernetes namespace that contains the secret
	Namespace string `yaml:"namespace" json:"namespace"`
	// SecretName is the name of the Kubernetes secret object
	SecretName string `yaml:"secretName" json:"secretName"`
	// SecretKey is the name of the key underneath .data which contains the credential
	SecretKey string `yaml:"secretKey" json:"secretKey"`
}

type UserMap struct {
	// ServerName is the name of the foreign server
	ServerName string `yaml:"-" json:"-"`
	// LocalUser is the name of the local database user to map
	LocalUser string `yaml:"localuser" json:"localuser"`
	// RemoteUser is the name of the remote database user to connect as
	RemoteUser string `yaml:"remoteuser" json:"remoteuser"`
	// RemoteSecret configures how to retrieve the optional credential for the RemoteUser user
	RemoteSecret Secret `yaml:"remotesecret" json:"remotesecret"`
}