resources

Documentation

Index

• Variables
• func ValidateEndpoints(extensionServers map[string]rest.Server, coreAddress string) error

Variables

var InternalEndpoints = rest.Resources{
	PathPrefix: internalTypes.InternalEndpoint,
	Endpoints: []rest.Endpoint{
		clusterInternalCmd,
		clusterMemberInternalCmd,
		databaseCmd,
		sqlCmd,
		heartbeatCmd,
		trustCmd,
		trustEntryCmd,
		hooksCmd,
	},
}

InternalEndpoints are the /core/internal API endpoints available at the listen address.

var LegacyEndpoints = rest.Resources{
	PathPrefix: internalTypes.LegacyEndpoint,
	Endpoints: []rest.Endpoint{
		databaseCmd,
	},
}

LegacyEndpoints allows access to the legacy /cluster/internal/database endpoint to facilitate upgrades to the newer endpoint path structure.

var PublicEndpoints = rest.Resources{
	PathPrefix: internalTypes.PublicEndpoint,
	Endpoints: []rest.Endpoint{
		api10Cmd,
		clusterCertificatesCmd,
		clusterCmd,
		clusterMemberCmd,
		daemonCmd,
		tokenCmd,
		readyCmd,
	},
}

PublicEndpoints are the /core/1.0 API endpoints available at the listen address.

var UnixEndpoints = rest.Resources{
	PathPrefix: internalTypes.ControlEndpoint,
	Endpoints: []rest.Endpoint{
		controlCmd,
		shutdownCmd,
		tokensCmd,
	},
}

UnixEndpoints are the endpoints available over the unix socket.

Functions

func ValidateEndpoints

func ValidateEndpoints(extensionServers map[string]rest.Server, coreAddress string) error

ValidateEndpoints checks if any endpoints defined in extensionServers conflict with other endpoints. An invalid server is defined as one of the following: - The PathPrefix+Path of an endpoint conflicts with another endpoint in the same server. - The address of the server clashes with another server. - The server does not have defined resources. - If the Server is a core API server:

• The PathPrefix+Path of an endpoint must not begin with `core`.
• Its resources must not conflict with any other core API server.
• It must not have a defined address or certificate.