package
4.0.2+incompatible
Repository: https://github.com/sulakshm/openstorage.git
Documentation: pkg.go.dev

# README

package apiserver

Package apiserver defines the REST endpoints for volume drivers.

The endpoints defined by the docker volume plugins API is a subset of the exposed REST endpoints.

# Packages

Package mock is a generated GoMock package.
Package sdk is the gRPC implementation of the SDK gRPC server Copyright 2018 Portworx Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.

# Functions

No description provided by the author
No description provided by the author
GetVolumeAPIRoutes returns all the volume routes.
GetVolumeAPIRoutesWithAuth returns a router with all the volume routes added to the router along with the auth middleware - preRouteCheckFn is a handler that gets executed before the actual volume handler is invoked.
NewAuthMiddleware returns a negroni implementation of an http middleware which will intercept the management APIs.
SecurityHandler implements Authentication and Authorization check at the same time this functionality where not moved to separate functions because of simplicity.
No description provided by the author
No description provided by the author
StartClusterAPI starts a REST server to receive driver configuration commands from the CLI/UX to control the OSD cluster.
StartGraphAPI starts a REST server to receive GraphDriver commands from the Linux container engine.
StartVolumeMgmtAPI starts a REST server to receive volume management API commands.
StartVolumePluginAPI starts a REST server to receive volume API commands from the linux container engine.

# Constants

GraphDriver is the string returned in the handshake protocol.
PVCNameLabelKey is used for kubernetes auth provider indicating the name of PVC.
PVCNamespaceLabelKey is used for kubernetes auth provider indicating the namespace of the PVC.
VolumeDriver is the string returned in the handshake protocol.

# Variables

OverrideSchedDriverName is set by osd program to override the schedule driver.

# Structs

AnonRegex defines a regex replace for a string.
Route is a specification and handler for a REST endpoint.

# Type aliases

ServerRegisterRoute is a callback function used by drivers to run their preRouteChecks before the actual volume route gets invoked This is added for legacy support before negroni middleware was added.