README
¶
Unikorn Server
Code Generation
Everything is done with an OpenAPI schema.
This allows us to auto-generate the server routing, schema validation middleware, types and clients.
This happens automatically on update via the Makefile.
Please ensure updated generated code is commited with your pull request.
API Definition
Consult the OpenAPI schema for full details of what it does.
Getting Started with Development and Testing.
Once everything is up and running, grab the IP address:
export INGRESS_ADDR=$(kubectl -n unikorn get ingress/unikorn-server -o 'jsonpath={.status.loadBalancer.ingress[0].ip}')
And add it to your resolver:
echo "${INGRESS_ADDR} kubernetes.eschercloud.com" >> /etc/hosts
API Testing
This does what a client is expected to do to bootstrap a session. Copy this, make a script, whatever works for you!
Get an Unscoped Token
When you first log in the the system you'll supply a username and password:
export TOKEN=$(curl -vkq https://kubernetes.eschercloud.com/api/v1/auth/tokens/password -X POST -u 'username:password' | jq -r .token)
Get a List of Projects
The token from the previous step allows very little functionality e.g. you cannot see any images or flavors. We need a scoped token for that:
curl -vkq https://kubernetes.eschercloud.com/api/v1/providers/openstack/projects -H "Authorization: Bearer ${TOKEN}" | jq .
It is anticipated that this step can be omitted most of the time for a Web application, as the project preference can be cached in window.localStorage to persist across sessions.
Get a Scoped Token
Grab a token that is scoped to a specific project and you can begin hitting other APIs:
export TOKEN=$(curl -vkq https://kubernetes.eschercloud.com/api/v1/auth/tokens/token -H "Authorization: Bearer ${TOKEN}" -d '{"project":{"id":"23a9e437091d481da99f2aa07180b4ea"}}' | jq -r token)
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Options ¶
type Options struct {
// ListenAddress tells the server what to listen on, you shouldn't
// need to change this, its already non-privileged and the default
// should be modified to avoid clashes with other services e.g prometheus.
ListenAddress string
// ReadTimeout defines how long before we give up on the client,
// this should be fairly short.
ReadTimeout time.Duration
// ReadHeaderTimeout defines how long before we give up on the client,
// this should be fairly short.
ReadHeaderTimeout time.Duration
// WriteTimeout defines how long we take to respond before we give up.
// Ideally we'd like this to be short, but Openstack in general sucks
// for performance. Additionally some calls like cluster creation can
// do a cascading create, e.g. create a default control plane, than in
// turn creates a project.
WriteTimeout time.Duration
// OTLPEndpoint defines whether to ship spans to an OTLP consumer or
// not, and where to send them to.
OTLPEndpoint string
// RequestTimeout places a hard limit on all requests lengths.
RequestTimeout time.Duration
}
Options allows server options to be overridden.
type Server ¶
type Server struct {
// Options are server specific options e.g. listener address etc.
Options Options
// ZapOptions configure logging.
ZapOptions zap.Options
// HandlerOptions sets options for the HTTP handler.
HandlerOptions handler.Options
// JoseOptions sets options for JWE.
JoseOptions jose.Options
// KeystoneOptions sets options for OpenStack Keystone.
KeystoneOptions keystone.Options
// OAuth2Options sets options for the oauth2/oidc authenticator.
OAuth2Options oauth2.Options
}
func (*Server) SetupLogging ¶
func (s *Server) SetupLogging()
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package generated provides primitives to interact with the openapi HTTP API.
|
Package generated provides primitives to interact with the openapi HTTP API. |