van api (#6)

* updates for client api

* work with errors

* service interface updates, expose host

* restructure controller

* update controller pipeline

* sasl config

Dockerfile

@@ -5,6 +5,6 @@ COPY . .
 
 RUN go mod download
 
-RUN go build -o controller cmd/skupper-docker-controller/main.go
+RUN go build -o controller cmd/skupper-docker-controller/main.go cmd/skupper-docker-controller/controller.go cmd/skupper-docker-controller/service_sync.go
 
 CMD ["/go/src/app/controller"]

Makefile

@@ -4,10 +4,10 @@ IMAGE := quay.io/skupper/skupper-docker-controller
 all: build-cmd build-controller
 
 build-cmd:
-	go build -ldflags="-X main.version=${VERSION}"  -o skupper-docker cmd/skupper-docker-cli/main.go
+	go build -ldflags="-X main.version=${VERSION}"  -o skupper-docker cmd/skupper-docker/main.go
 
 build-controller:
-	go build -ldflags="-X main.version=${VERSION}"  -o skupper-docker-controller cmd/skupper-docker-controller/main.go
+	go build -ldflags="-X main.version=${VERSION}"  -o skupper-docker-controller cmd/skupper-docker-controller/main.go cmd/skupper-docker-controller/controller.go cmd/skupper-docker-controller/service_sync.go
 
 docker-build:
 	docker build -t ${IMAGE} .
@@ -23,17 +23,17 @@ package: release/windows.zip release/darwin.zip release/linux.tgz
 release/linux.tgz: release/linux/skupper-docker
 	tar -czf release/linux.tgz -C release/linux/ skupper-docker
 
-release/linux/skupper-docker: cmd/skupper-docker-cli/main.go
-	GOOS=linux GOARCH=amd64 go build -ldflags="-X main.version=${VERSION}" -o release/linux/skupper-docker cmd/skupper-docker-cli/main.go
+release/linux/skupper-docker: cmd/skupper-docker/main.go
+	GOOS=linux GOARCH=amd64 go build -ldflags="-X main.version=${VERSION}" -o release/linux/skupper-docker cmd/skupper-docker/main.go
 
-release/windows/skupper-docker: cmd/skupper-docker-cli/main.go
-	GOOS=windows GOARCH=amd64 go build -ldflags="-X main.version=${VERSION}" -o release/windows/skupper-docker cmd/skupper-docker-cli/main.go
+release/windows/skupper-docker: cmd/skupper-docker/main.go
+	GOOS=windows GOARCH=amd64 go build -ldflags="-X main.version=${VERSION}" -o release/windows/skupper-docker cmd/skupper-docker/main.go
 
 release/windows.zip: release/windows/skupper-docker
 	zip -j release/windows.zip release/windows/skupper-docker
 
-release/darwin/skupper-docker: cmd/skupper-docker-cli/main.go
-	GOOS=darwin GOARCH=amd64 go build -ldflags="-X main.version=${VERSION}" -o release/darwin/skupper-docker cmd/skupper-docker-cli/main.go
+release/darwin/skupper-docker: cmd/skupper-docker/main.go
+	GOOS=darwin GOARCH=amd64 go build -ldflags="-X main.version=${VERSION}" -o release/darwin/skupper-docker cmd/skupper-docker/main.go
 
 release/darwin.zip: release/darwin/skupper-docker
 	zip -j release/darwin.zip release/darwin/skupper-docker

api/types/client.go

@@ -0,0 +1,50 @@
+package types
+
+type VanConnectorCreateOptions struct {
+	Name string
+	Cost int32
+}
+
+type VanRouterCreateOptions struct {
+	SkupperName       string
+	IsEdge            bool
+	EnableController  bool
+	EnableServiceSync bool
+	EnableConsole     bool
+	AuthMode          string
+	User              string
+	Password          string
+	ClusterLocal      bool
+	Replicas          int32
+}
+
+type VanServiceInterfaceCreateOptions struct {
+	Protocol   string
+	Address    string
+	Port       int
+	TargetPort int
+	Headless   bool
+}
+
+type VanServiceInterfaceRemoveOptions struct {
+	Address string
+}
+
+type VanRouterInspectResponse struct {
+	Status            VanRouterStatusSpec
+	TransportVersion  string
+	ControllerVersion string
+	ExposedServices   int
+}
+
+type VanConnectorInspectResponse struct {
+	Connector *Connector
+	Connected bool
+}
+
+type VanRouterStatusSpec struct {
+	Mode                   string                  `json:"mode,omitempty"`
+	TransportReadyReplicas int32                   `json:"transportReadyReplicas,omitempty"`
+	ConnectedSites         TransportConnectedSites `json:"connectedSites,omitempty"`
+	BindingsCount          int                     `json:"bindingsCount,omitempty"`
+}

api/types/types.go

@@ -0,0 +1,242 @@
+/*
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package types
+
+import (
+	"github.com/docker/go-connections/nat"
+)
+
+const (
+	DefaultVanName   string = "skupper"
+	HostPath         string = "/tmp/skupper"
+	CertPath                = HostPath + "/qpid-dispatch-certs/"
+	ConnPath                = HostPath + "/connections/"
+	ConsoleUsersPath        = HostPath + "/console-users/"
+	SaslConfigPath          = HostPath + "/sasl-config/"
+	ServicePath             = HostPath + "/services/"
+)
+
+// TransportMode describes how a qdr is intended to be deployed, either interior or edge
+type TransportMode string
+
+const (
+	// TransportModeInterior means the qdr will participate in inter-router protocol exchanges
+	TransportModeInterior TransportMode = "interior"
+	// TransportModeEdge means that the qdr will connect to interior routers for network access
+	TransportModeEdge = "edge"
+)
+
+// Transport constants
+const (
+	TransportDeploymentName string = "skupper-router"
+	TransportComponentName  string = "router"
+	DefaultTransportImage   string = "quay.io/interconnectedcloud/qdrouterd"
+	TransportContainerName  string = "router"
+	TransportLivenessPort   int32  = 9090
+	TransportEnvConfig      string = "QDROUTERD_CONF"
+	TransportSaslConfig     string = "skupper-sasl-config"
+	TransportNetworkName    string = "skupper-network"
+)
+
+var TransportPrometheusAnnotations = map[string]string{
+	"prometheus.io/port":   "9090",
+	"prometheus.io/scrape": "true",
+}
+
+// Controller constants
+const (
+	ControllerDeploymentName string = "skupper-proxy-controller"
+	ControllerComponentName  string = "controller"
+	DefaultControllerImage   string = "quay.io/skupper/skupper-docker-controller"
+	ControllerContainerName  string = "proxy-controller"
+	DefaultProxyImage        string = "quay.io/skupper/proxy-simple"
+	ControllerConfigPath     string = "/etc/messaging/"
+)
+
+// Console constants
+const (
+	ConsolePortName                        string = "console"
+	ConsoleServiceName                     string = "skupper-console"
+	ConsoleDefaultServicePort              int32  = 8080
+	ConsoleDefaultServiceTargetPort        int32  = 8080
+	ConsoleOpenShiftServicePort            int32  = 8888
+	ConsoleOpenShiftOauthServicePort       int32  = 443
+	ConsoleOpenShiftOuathServiceTargetPort int32  = 8443
+	ConsoleOpenShiftServingCerts           string = "skupper-proxy-certs"
+)
+
+type ConsoleAuthMode string
+
+const (
+	ConsoleAuthModeInternal  ConsoleAuthMode = "internal"
+	ConsoleAuthModeUnsecured                 = "unsecured"
+)
+
+// Assembly constants
+const (
+	EdgeRole                string = "edge"
+	EdgeRouteName           string = "skupper-edge"
+	EdgeListenerPort        int32  = 45671
+	InterRouterRole         string = "inter-router"
+	InterRouterListenerPort int32  = 55671
+	InterRouterRouteName    string = "skupper-inter-router"
+	InterRouterProfile      string = "skupper-internal"
+)
+
+// Controller Service Interface constants
+const (
+	ServiceSyncAddress   = "mc/$skupper-service-sync"
+	LocalServiceDefsFile = ServicePath + "/local/skupper-services"
+	AllServiceDefsFile   = ServicePath + "/all/skupper-services"
+)
+
+// TODO: what is possiblity of using types from skupper itself (e.g. no namespace for docker
+// or we change the name to endpoint, etc.
+// VanRouterSpec is the specification of VAN network with router, controller and assembly
+type VanRouterSpec struct {
+	Name string `json:"name,omitempty"`
+	//	Namespace      string          `json:"namespace,omitempty"`
+	AuthMode       ConsoleAuthMode `json:"authMode,omitempty"`
+	Transport      DeploymentSpec  `json:"transport,omitempty"`
+	Controller     DeploymentSpec  `json:"controller,omitempty"`
+	Assembly       AssemblySpec    `json:"assembly,omitempty"`
+	Users          []User          `json:"users,omitempty"`
+	CertAuthoritys []CertAuthority `json:"certAuthoritys,omitempty"`
+	Credentials    []Credential    `json:"credentials,omitempty"`
+}
+
+// DeploymentSpec for the VAN router or controller components to run within a cluster
+type DeploymentSpec struct {
+	Image        string            `json:"image,omitempty"`
+	LivenessPort int32             `json:"livenessPort,omitempty"`
+	Labels       map[string]string `json:"labels,omitempty"`
+	//	Annotations     map[string]string      `json:"annotations,omitempty"`
+	EnvVar  []string          `json:"envVar,omitempty"`
+	Ports   nat.PortSet       `json:"ports,omitempty"`
+	Volumes []string          `json:"volumes,omitempty"`
+	Mounts  map[string]string `json:"mounts,omitempty"`
+}
+
+// AssemblySpec for the links and connectors that form the VAN topology
+type AssemblySpec struct {
+	Name                  string       `json:"name,omitempty"`
+	Mode                  string       `json:"mode,omitempty"`
+	Listeners             []Listener   `json:"listeners,omitempty"`
+	InterRouterListeners  []Listener   `json:"interRouterListeners,omitempty"`
+	EdgeListeners         []Listener   `json:"edgeListeners,omitempty"`
+	SslProfiles           []SslProfile `json:"sslProfiles,omitempty"`
+	Connectors            []Connector  `json:"connectors,omitempty"`
+	InterRouterConnectors []Connector  `json:"interRouterConnectors,omitempty"`
+	EdgeConnectors        []Connector  `json:"edgeConnectors,omitempty"`
+}
+
+type Listener struct {
+	Name             string `json:"name,omitempty"`
+	Host             string `json:"host,omitempty"`
+	Port             int32  `json:"port"`
+	RouteContainer   bool   `json:"routeContainer,omitempty"`
+	Http             bool   `json:"http,omitempty"`
+	Cost             int32  `json:"cost,omitempty"`
+	SslProfile       string `json:"sslProfile,omitempty"`
+	SaslMechanisms   string `json:"saslMechanisms,omitempty"`
+	AuthenticatePeer bool   `json:"authenticatePeer,omitempty"`
+	LinkCapacity     int32  `json:"linkCapacity,omitempty"`
+}
+
+type SslProfile struct {
+	Name   string `json:"name,omitempty"`
+	Cert   string `json:"cert,omitempty"`
+	Key    string `json:"key,omitempty"`
+	CaCert string `json:"caCert,omitempty"`
+}
+
+type ConnectorRole string
+
+const (
+	ConnectorRoleInterRouter ConnectorRole = "inter-router"
+	ConnectorRoleEdge                      = "edge"
+)
+
+type Connector struct {
+	Name           string `json:"name,omitempty"`
+	Role           string `json:"role,omitempty"`
+	Host           string `json:"host"`
+	Port           string `json:"port"`
+	RouteContainer bool   `json:"routeContainer,omitempty"`
+	Cost           int32  `json:"cost,omitempty"`
+	VerifyHostname bool   `json:"verifyHostname,omitempty"`
+	SslProfile     string `json:"sslProfile,omitempty"`
+	LinkCapacity   int32  `json:"linkCapacity,omitempty"`
+}
+
+type Credential struct {
+	CA          string
+	Name        string
+	Subject     string
+	Hosts       string
+	ConnectJson bool
+	Post        bool
+}
+
+type CertAuthority struct {
+	Name string
+}
+
+type User struct {
+	Name     string
+	Password string
+}
+
+type TransportConnectedSites struct {
+	Direct   int
+	Indirect int
+	Total    int
+}
+
+type ServiceInterface struct {
+	Address  string                   `json:"address"`
+	Protocol string                   `json:"protocol"`
+	Port     int                      `json:"port"`
+	Headless *Headless                `json:"headless,omitempty"`
+	Targets  []ServiceInterfaceTarget `json:"targets"`
+	Origin   string                   `json:"origin,omitempty"`
+	Alias    string                   `json:"alias,omitempty"`
+}
+
+type ServiceInterfaceTarget struct {
+	Name       string `json:"name,omitempty"`
+	Selector   string `json:"selector"`
+	TargetPort int    `json:"targetPort,omitempty"`
+}
+
+type Headless struct {
+	Name       string `json:"name"`
+	Size       int    `json:"size"`
+	TargetPort int    `json:"targetPort,omitempty"`
+}
+
+type ByServiceInterfaceAddress []ServiceInterface
+
+func (a ByServiceInterfaceAddress) Len() int {
+	return len(a)
+}
+
+func (a ByServiceInterfaceAddress) Less(i, j int) bool {
+	return a[i].Address > a[i].Address
+}
+
+func (a ByServiceInterfaceAddress) Swap(i, j int) {
+	a[i], a[j] = a[j], a[i]
+}

client/client.go

@@ -0,0 +1,20 @@
+package client
+
+import (
+	"time"
+
+	"github.com/skupperproject/skupper-docker/pkg/docker/libdocker"
+)
+
+// A VAN client manages orchestration and communication with the network components
+type VanClient struct {
+	DockerInterface libdocker.Interface
+}
+
+func NewClient(endpoint string) (*VanClient, error) {
+	c := &VanClient{}
+
+	c.DockerInterface = libdocker.ConnectToDockerOrDie(endpoint, 0, 10*time.Second)
+
+	return c, nil
+}