ucptypes

Documentation

Index

• Constants
• type Account
• type AccountList
• type ClientBundles
• type Collection
• type CollectionLabelConstraints
• type ContainerProcesses
• type Grant
• type HRMConfig
• type InterlockConfig
• type LDAPConfig
• type Roles
• type SearchConfig
• type ServiceConfig
• type Team
• type Teams

Constants

const (
	// GrantCollection - (default) specifies a grant is created against a collection
	GrantCollection uint = 1 << iota

	// GrantNamespace - A grant is made against a namespace (kubernetes)
	GrantNamespace

	// GrantObject - kubernetesnamespaces target, which is used to give grants against all Kubernetes namespaces.
	GrantObject
)

Types

type Account

type Account struct {
	FullName   string `json:"fullName"`
	ID         string `json:"id"`
	IsActive   bool   `json:"isActive"`
	IsAdmin    bool   `json:"isAdmin"`
	IsOrg      bool   `json:"isOrg"`
	Name       string `json:"name"`
	Password   string `json:"password"`
	SearchLDAP bool   `json:"searchLDAP"`
}

Account - Is the basic Account struct

type AccountList

type AccountList struct {
	Accounts []Account `json:"accounts"`
}

AccountList - The format returned by a query of accounts

type ClientBundles

type ClientBundles struct {
	AccountPublicKeys []struct {
		ID           string `json:"id"`
		AccountID    string `json:"accountID"`
		PublicKey    string `json:"publicKey"`
		Label        string `json:"label"`
		Certificates []struct {
			Label string `json:"label"`
			Cert  string `json:"cert"`
		} `json:"certificates"`
	} `json:"accountPublicKeys"`
}

ClientBundles - defines a client bundle list response

type Collection

type Collection struct {
	CreatedAt        time.Time                    `json:"created_at"`
	ID               string                       `json:"id"`
	LabelConstraints []CollectionLabelConstraints `json:"label_constraints"`
	Legacylabelkey   string                       `json:"legacylabelkey"`
	Legacylabelvalue string                       `json:"legacylabelvalue"`
	Name             string                       `json:"name"`
	ParentIds        []string                     `json:"parent_ids"`
	Path             string                       `json:"path"`
	UpdatedAt        time.Time                    `json:"updated_at"`
}

Collection - An array of JSON Structs that detail the collections in Docker UCP

type CollectionLabelConstraints

type CollectionLabelConstraints struct {
	Equality   bool   `json:"equality"`
	LabelKey   string `json:"label_key"`
	LabelValue string `json:"label_value"`
	Type       string `json:"type"`
}

CollectionLabelConstraints - defines constraints to be applied to a collection

type ContainerProcesses

type ContainerProcesses struct {
	Processes [][]string `json:"Processes"`
	Titles    []string   `json:"Titles"`
}

ContainerProcesses - Struct that defines all Processes in a container

type Grant

type Grant struct {
	ObjectID  string `json:"objectID"`
	RoleID    string `json:"roleID"`
	SubjectID string `json:"subjectID"`
}

Grant - the the three elements needed for a grant

type HRMConfig

type HRMConfig struct {
	HTTPPort  int    `json:"HTTPPort"`
	HTTPSPort int    `json:"HTTPSPort"`
	Arch      string `json:"Arch"`
}

HRMConfig - configuration for HRM layer 7 routing

type InterlockConfig

type InterlockConfig struct {
	HTTPPort         int    `json:"HTTPPort"`
	HTTPSPort        int    `json:"HTTPSPort"`
	Arch             string `json:"Arch"`
	InterlockEnabled bool   `json:"InterlockEnabled"`
}

InterlockConfig - configuration for Interlock layer 7 routing

type LDAPConfig

type LDAPConfig struct {
	ServerURL          string `json:"serverURL"`
	NoSimplePagination bool   `json:"noSimplePagination"`
	StartTLS           bool   `json:"startTLS"`
	RootCerts          string `json:"rootCerts"`
	TLSSkipVerify      bool   `json:"tlsSkipVerify"`
	ReaderDN           string `json:"readerDN"`
	// This isn't returned from the GET as once the password is added it can't be modified
	ReaderPassword    string         `json:"readerPassword"`
	AdditionalDomains []interface{}  `json:"additionalDomains"`
	UserSearchConfigs []SearchConfig `json:"userSearchConfigs"`
	AdminSyncOpts     struct {
		EnableSync         bool   `json:"enableSync"`
		SelectGroupMembers bool   `json:"selectGroupMembers"`
		GroupDN            string `json:"groupDN"`
		GroupMemberAttr    string `json:"groupMemberAttr"`
		SearchBaseDN       string `json:"searchBaseDN"`
		SearchScopeSubtree bool   `json:"searchScopeSubtree"`
		SearchFilter       string `json:"searchFilter"`
	} `json:"adminSyncOpts"`
	SyncSchedule        string `json:"syncSchedule"`
	JitUserProvisioning bool   `json:"jitUserProvisioning"`
}

LDAPConfig - This is the LDAP configuration struct

type Roles

type Roles struct {
	ID         string          `json:"id"`
	Name       string          `json:"name"`
	SystemRole bool            `json:"system_role"`
	Operations json.RawMessage // Captures the raw output of the remaining json object
}

Roles are the structure the defines a role

type SearchConfig

type SearchConfig struct {
	UserAttr string `json:"usernameAttr"`
	BaseDN   string `json:"baseDN"`
}

SearchConfig - The configuration for a search struct on an LDAP tree

type ServiceConfig

type ServiceConfig struct {
	ID      string `json:"ID"`
	Version struct {
		Index int `json:"Index"`
	} `json:"Version"`
	CreatedAt time.Time `json:"CreatedAt"`
	UpdatedAt time.Time `json:"UpdatedAt"`
	Spec      struct {
		Name   string `json:"Name"`
		Labels struct {
			Label []map[string]string
		} `json:"Labels"`
		Data string `json:"Data"`
	} `json:"Spec"`
}

ServiceConfig - Used to interact with configurations applied to services

type Team

type Team struct {
	Description  string `json:"description"`
	ID           string `json:"id"`
	MembersCount int    `json:"membersCount"`
	Name         string `json:"name"`
	OrgID        string `json:"orgID"`
}

Team - is the structure for defining a team

type Teams

type Teams struct {
	NextPage      string `json:"nextPageStart"`
	ResourceCount int    `json:"resourceCount"`
	Teams         []Team `json:"teams"`
}

Teams is returned from querying an organisation