Join will join an existing OVN deployment.

Leave function gracefully departs from the OVN cluster before the member is removed from MicroOVN cluster. It ensures that: - OVN chassis is stopped a

ListServices - List services in database (desired state).

Log emits a structured security event at INFO level, it is a no-op when security logging has been disabled via SetEnabled

NBCtl is a convenience function for execution of ovn-nbctl command against OVN NB local unix socket. The command is re-tried up to 3 times. If command

NBCtlCluster is a convenience function for execution of ovn-nbctl command against OVN NB cluster endpoints. The command is re-tried up to 3 times. If

NewRegenerateCaResponse returns pointer to initialized RegenerateCaResponse object

NewRegenerateEnvResponse returns pointer to initialized RegenerateEnvResponse object

OvnEnvFile returns path to the file used to configure env variables for OVN commands

OvnNBControlSock returns path to the local control socket for Northbound OVN service

OvnNBDatabaseSock returns path to the local unix socket used by Northbound OVN database

OvnSBControlSock returns path to the local control socket for Southbound OVN service

OvnSBDatabaseSock returns path to the local unix socket used by Southbound OVN database

OvsDatabaseSock returns path to the local unix socket used by OpenvSwitch database

OvsdbClient is a wrapper function that executes 'ovsdb-client' command. It first ensures that the database is connected and returns error if the datab

OvsdbNbSchema returns path to schema file for OVN Northbound database

OvsdbSbSchema returns path to schema file for OVN Southbound database

OvsdbSwitchSchema returns path to schema file for OpenvSwitch

PkiCaCertFile returns path to CA certificate file

PkiClientCertFiles returns paths to certificate and private key used by client

PkiOvnControllerCertFiles returns paths to certificate and private key used by OVN Controller

PkiOvnNbCertFiles returns paths to certificate and private key used by OVN Northbound service

PkiOvnNorthdCertFiles returns paths to certificate and private key used by OVN Northd service

PkiOvnSbCertFiles returns paths to certificate and private key used by OVN Southbound service

PrettyPrint method formats and prints contents of RegenerateEnvResponse object

Refresh will update the existing OVN central and OVS switch configs.

RegenerateCA sends request to completely rebuild the OVN PKI. It causes new CA certificate to be issued and shared between MicroOVN cluster members, a

ReissueAllCertificate sends request to local MicroOVN cluster member to re-issue new certificates for every enabled OVN service present.

ReissueCertificate sends request to local MicroOVN cluster member to re-issue new certificate for selected service.

Reload - reload snap service as represented by "service" string.

RequiredDirs returns list of all directories that need to be created for MicroOVN to function properly

Restart - restart snap service as represented by "service" string.

Root returns $SNAP_COMMON root of MicroOVN

Run method is an implementation of the "microovn config list" subcommand

Run method is an implementation of "microovn certificates list" subcommand

Run method is an implementation of the "microovn config get" subcommand

Run method is an implementation of "microovn certificates reissue" subcommand. It requests local MicroOVN service to issue new certificate for selecte

Run method is an implementation of the "microovn config delete" subcommand

Run method implements the functionality of "microovn certificates set-ca" command. It reads the provided certificate and key files, then requests loca

Run method is an implementation of "microovn certificates regenerate-ca" subcommand. It requests cluster to issue new CA certificate and re-issue all

Run method is an implementation of the "microovn config set" subcommand

SBCtl is a convenience function for execution of ovn-sbctl command against OVN NB local unix socket. The command is re-tried up to 3 times. If command

ServiceWarnings - checks the desired state and aims to find out if there are any problems with it, such as an inefficent or error prone number of node

SetCA sends a request to set a user-provided CA certificate and private key. It triggers re-issue of all OVN service certificates on all MicroOVN clus

SetConfig sends a request to the MicroOVN server that sets or updates a value of a configuration option.

SetConfig function inserts or updates rows in the "config" table of the MicroOVNs database.

SetEnabled turns security event logging on or off

SetNewCACertificate verifies basic attributes of the provided certificate and private key and stores them in the shared MicroOVN database.

Start will update the existing OVN central and OVS switch configs.

Start - start snap service as represented by "service" string, optionally leaving it enabled for future reboots when "enable" is true.

Stop stops specified snap service. Service can be optionally also disabled, ensuring that it won't be automatically started on system reboot.

UpdateConfigItem updates the ConfigItem matching the given key parameters. generator: ConfigItem Update

UpdateOvnControllerRemoteConfig updates the value of "external_ids:remote-ovn" in the Open vSwitch database. This value tells the OVN controller the l

UpdateOvnListenConfig configures the OVN NB and SB databases to listen on the appropriate ports.

UpdateService updates the service matching the given key parameters. generator: service Update

UpgradeCentralDB checks whether a schema upgrade for the specified DB is required. If so, it triggers a coordinated approach to an OVSDB cluster schem

VSCtl is a convenience function for execution of ovs-vsctl command which is re-tried up to 3 times. If command arguments do not specify timeout (-t or

Wrappers returns path to a directory with snap's command wrappers

WriteToNetplan writes a file and then moves it to the netplan directory, due to permissions issues writing to /etc/netplan directly fails

cmdServicesGet - handles services endpoint functionality, by calling the respective function within node and then handling any errors it throws.

configItemColumns returns a string of column names to be used with a SELECT statement for the entity. Use this function when building statements to re

deleteConfig handles DELETE requests to the config endpoint by completely removing the config option

disableService - function to handle to service control delete request, which aims to disable a service. This will return a response which contains a

enableService - function to handle to service control put request, which aims to enable a service. This will return a response which contains a Warni

getActiveSchemaVersion implements GET method for /1.0/ovsdb/schema/<db-name>/active. It returns currently active schema version of a database specifie

getAllExpectedSchemaVersions implements GET method for /1.0/ovsdb/schema/<db-name>/expected/all. It returns expected schema version for the given data

getConfig handles GET requests to the config endpoint by returning the current config option value

getExpectedSchemaVersion implements GET method for /1.0/ovsdb/schema/<db-name>/expected. It returns expected schema version of the specified database

infoCaGet returns additional information about CA certificate

issueCertificatesAllPut implements PUT method for /1.0/certificates endpoint. The function issues new certificates for every OVN service enabled on th

issueCertificatesPut implements PUT method for /1.0/certificates/<service-name> endpoint. The function parses service name from the request URL and if

ovnCentralIpsUpdated is a handler for changes to the "ovn.central-ips" config option change. It triggers microovn.api.RegenerateEnvEndpoint to refresh

printCertStatus prints status of individual files in certificate bundle

printCertStatus prints status of CA certificate