diff --git a/.idea/modules.xml b/.idea/modules.xml
new file mode 100644
index 00000000..9758b7ad
--- /dev/null
+++ b/.idea/modules.xml
@@ -0,0 +1,8 @@
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/.idea/norman.iml b/.idea/norman.iml
new file mode 100644
index 00000000..c956989b
--- /dev/null
+++ b/.idea/norman.iml
@@ -0,0 +1,8 @@
+
+
+
+
+
\ No newline at end of file
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
new file mode 100644
index 00000000..94a25f7f
--- /dev/null
+++ b/.idea/vcs.xml
@@ -0,0 +1,6 @@
+
+
+
+
+
\ No newline at end of file
diff --git a/.idea/workspace.xml b/.idea/workspace.xml
new file mode 100644
index 00000000..89f58703
--- /dev/null
+++ b/.idea/workspace.xml
@@ -0,0 +1,818 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ true
+ DEFINITION_ORDER
+
+
+
+
+
+
+
+
+
+
+ Abstraction issuesJava
+
+
+ Assignment issuesJava
+
+
+ Bitwise operation issuesJava
+
+
+ Class metricsJava
+
+
+ Class structureJava
+
+
+ Cloning issuesJava
+
+
+ Code maturity issuesJava
+
+
+ Code style issuesJava
+
+
+ Compiler issuesJava
+
+
+ Concurrency annotation issuesJava
+
+
+ Control flow issuesJava
+
+
+ Data flow issuesJava
+
+
+ Declaration redundancyJava
+
+
+ Dependency issuesJava
+
+
+ Encapsulation issuesJava
+
+
+ Error handlingJava
+
+
+ Finalization issuesJava
+
+
+ GPath inspectionsGroovy
+
+
+ General
+
+
+ GeneralJava
+
+
+ Groovy
+
+
+ ImportsJava
+
+
+ Inheritance issuesJava
+
+
+ Initialization issuesJava
+
+
+ Internationalization issuesJava
+
+
+ J2ME issuesJava
+
+
+ JUnit issuesJava
+
+
+ Java
+
+
+ Java 5Java language level migration aidsJava
+
+
+ Java 7Java language level migration aidsJava
+
+
+ Java 8Java language level migration aidsJava
+
+
+ Java language level issuesJava
+
+
+ Java language level migration aidsJava
+
+
+ JavaBeans issuesJava
+
+
+ JavaFX
+
+
+ Javadoc issuesJava
+
+
+ Kotlin
+
+
+ Language Injection
+
+
+ Logging issuesJava
+
+
+ Manifest
+
+
+ Memory issuesJava
+
+
+ Method metricsJava
+
+
+ Modularization issuesJava
+
+
+ Naming ConventionsGroovy
+
+
+ Naming conventionsJava
+
+
+ Numeric issuesJava
+
+
+ Packaging issuesJava
+
+
+ Performance issuesJava
+
+
+ Portability issuesJava
+
+
+ Potentially confusing code constructsGroovy
+
+
+ Probable bugsGroovy
+
+
+ Probable bugsJava
+
+
+ Properties Files
+
+
+ Properties FilesJava
+
+
+ Resource management issuesJava
+
+
+ Security issuesJava
+
+
+ Serialization issuesJava
+
+
+ StyleGroovy
+
+
+ Threading issuesGroovy
+
+
+ Threading issuesJava
+
+
+ Verbose or redundant code constructsJava
+
+
+ Visibility issuesJava
+
+
+ toString() issuesJava
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/handler/browser.go b/handler/browser.go
new file mode 100644
index 00000000..8e9bb2ab
--- /dev/null
+++ b/handler/browser.go
@@ -0,0 +1,18 @@
+package handler
+
+import (
+ "net/http"
+ "strings"
+)
+
+func IsBrowser(req *http.Request, checkAccepts bool) bool {
+ accepts := strings.ToLower(req.Header.Get("Accept"))
+ userAgent := strings.ToLower(req.Header.Get("User-Agent"))
+
+ if accepts == "" || !checkAccepts {
+ accepts = "*/*"
+ }
+
+ // User agent has Mozilla and browser accepts */*
+ return strings.Contains(userAgent, "mozilla") && strings.Contains(accepts,"*/*")
+}
diff --git a/handler/csrf.go b/handler/csrf.go
new file mode 100644
index 00000000..f2b9d1be
--- /dev/null
+++ b/handler/csrf.go
@@ -0,0 +1,53 @@
+package handler
+
+import (
+ "crypto/rand"
+ "encoding/hex"
+ "net/http"
+
+ "github.com/rancher/norman/httperror"
+)
+
+const (
+ csrfCookie = "CSRF"
+ csrfHeader = "X-API-CSRF"
+)
+
+func CheckCSRF(rw http.ResponseWriter, req *http.Request) error {
+ if !IsBrowser(req, false) {
+ return nil
+ }
+
+ cookie, err := req.Cookie(csrfCookie)
+ if err != nil {
+ return httperror.NewAPIError(httperror.INVALID_CSRF_TOKEN, "Failed to parse cookies")
+ }
+
+ if cookie == nil {
+ bytes := make([]byte, 5)
+ _, err := rand.Read(bytes)
+ if err != nil {
+ return httperror.WrapAPIError(err, httperror.SERVER_ERROR, "Failed in CSRF processing")
+ }
+
+ cookie = &http.Cookie{
+ Name: csrfCookie,
+ Value: hex.EncodeToString(bytes),
+ }
+ } else if req.Method != http.MethodGet {
+ /*
+ * Very important to use request.getMethod() and not httpRequest.getMethod(). The client can override the HTTP method with _method
+ */
+ if cookie.Value == req.Header.Get(csrfHeader) {
+ // Good
+ } else if cookie.Value == req.URL.Query().Get(csrfCookie) {
+ // Good
+ } else {
+ return httperror.NewAPIError(httperror.INVALID_CSRF_TOKEN, "Invalid CSRF token")
+ }
+ }
+
+ cookie.Path = "/"
+ http.SetCookie(rw, cookie)
+ return nil
+}
diff --git a/handler/parse_collection.go b/handler/parse_collection.go
new file mode 100644
index 00000000..7dbe69eb
--- /dev/null
+++ b/handler/parse_collection.go
@@ -0,0 +1,130 @@
+package handler
+
+import (
+ "net/http"
+
+ "strconv"
+
+ "strings"
+
+ "github.com/rancher/go-rancher/v3"
+ "github.com/rancher/norman/query"
+)
+
+var (
+ ASC = SortOrder("asc")
+ DESC = SortOrder("desc")
+ defaultLimit = 100
+ maxLimit = 3000
+)
+
+type SortOrder string
+
+type Pagination struct {
+ Limit int
+ Marker string
+}
+
+type CollectionAttributes struct {
+ Sort string
+ Order SortOrder
+ Pagination *Pagination
+ Conditions []*query.Condition
+}
+
+func ParseCollectionAttributes(req *http.Request, schema client.Schema) *CollectionAttributes {
+ if req.Method != http.MethodGet {
+ return nil
+ }
+
+ result := &CollectionAttributes{}
+
+ result.Order = parseOrder(req)
+ result.Sort = parseSort(schema, req)
+ result.Pagination = parsePagination(req)
+ result.Conditions = parseFilters(schema, req)
+
+ return result
+}
+
+func parseOrder(req *http.Request) SortOrder {
+ order := req.URL.Query().Get("order")
+ if SortOrder(order) == DESC {
+ return DESC
+ }
+ return ASC
+}
+
+func parseSort(schema client.Schema, req *http.Request) string {
+ sort := req.URL.Query().Get("sort")
+ if _, ok := schema.CollectionFilters[sort]; ok {
+ return sort
+ }
+ return ""
+}
+
+func parsePagination(req *http.Request) *Pagination {
+ q := req.URL.Query()
+ limit := q.Get("limit")
+ marker := q.Get("marker")
+
+ result := &Pagination{
+ Limit: defaultLimit,
+ Marker: marker,
+ }
+
+ if limit != "" {
+ limitInt, err := strconv.Atoi(limit)
+ if err != nil {
+ return result
+ }
+
+ if limitInt > maxLimit {
+ result.Limit = maxLimit
+ } else if limitInt > 0 {
+ result.Limit = limitInt
+ }
+ }
+
+ return result
+}
+
+func parseNameAndOp(value string) (string, string) {
+ name := value
+ op := "eq"
+
+ idx := strings.LastIndex(value, "_")
+ if idx > 0 {
+ op = value[idx+1:]
+ name = value[0:idx]
+ }
+
+ return name, op
+}
+
+func parseFilters(schema client.Schema, req *http.Request) []*query.Condition {
+ conditions := []*query.Condition{}
+ q := req.URL.Query()
+ for key, values := range req.URL.Query() {
+ name, op := parseNameAndOp(key)
+ filter, ok := schema.CollectionFilters[name]
+ if !ok {
+ continue
+ }
+
+ for _, mod := range filter.Modifiers {
+ if op != mod || !query.ValidMod(op) {
+ continue
+ }
+
+ genericValues := []interface{}{}
+ for _, value := range values {
+ genericValues = append(genericValues, value)
+ }
+
+ conditions = append(conditions, query.NewCondition(query.ConditionType(mod), genericValues))
+ }
+ }
+
+ return conditions
+}
diff --git a/handler/read_input.go b/handler/read_input.go
new file mode 100644
index 00000000..379abe3c
--- /dev/null
+++ b/handler/read_input.go
@@ -0,0 +1,37 @@
+package handler
+
+import (
+ "net/http"
+ "io/ioutil"
+ "io"
+ "github.com/rancher/norman/httperror"
+ "fmt"
+ "encoding/json"
+)
+
+const reqMaxSize = (2 * 1<<20) + 1
+
+var bodyMethods = map[string]bool{
+ http.MethodPut: true,
+ http.MethodPost: true,
+}
+
+func ReadBody(rw http.ResponseWriter, req *http.Request) (map[string]interface{}, error) {
+ if !bodyMethods[req.Method] {
+ return nil, nil
+ }
+
+ content, err := ioutil.ReadAll(io.LimitReader(req.Body, reqMaxSize))
+ if err != nil {
+ return nil, httperror.NewAPIError(httperror.INVALID_BODY_CONTENT,
+ fmt.Sprintf("Body content longer than %d bytes", reqMaxSize-1))
+ }
+
+ data := map[string]interface{}{}
+ if err := json.Unmarshal(content, data); err != nil {
+ return nil, httperror.NewAPIError(httperror.INVALID_BODY_CONTENT,
+ fmt.Sprintf("Failed to parse body: %v", err))
+ }
+
+ return data, nil
+}
diff --git a/handler/validation.go b/handler/validation.go
new file mode 100644
index 00000000..dbd1152d
--- /dev/null
+++ b/handler/validation.go
@@ -0,0 +1,320 @@
+package handler
+
+import (
+ "fmt"
+ "strconv"
+ "strings"
+
+ "github.com/rancher/go-rancher/v3"
+ "github.com/rancher/norman/httperror"
+ "github.com/rancher/norman/registry"
+ "github.com/rancher/norman/store"
+)
+
+var (
+ Create = Operation("create")
+ Update = Operation("update")
+ Action = Operation("action")
+)
+
+type Operation string
+
+type Builder struct {
+ Registry registry.SchemaRegistry
+ RefValidator store.ReferenceValidator
+}
+
+func (b *Builder) Construct(schema *client.Schema, input map[string]interface{}, op Operation) (map[string]interface{}, error) {
+ return b.copyFields(schema, input, op)
+}
+
+func (b *Builder) copyInputs(schema *client.Schema, input map[string]interface{}, op Operation, result map[string]interface{}) error {
+ for fieldName, value := range input {
+ field, ok := schema.ResourceFields[fieldName]
+ if !ok {
+ continue
+ }
+
+ if !fieldMatchesOp(field, op) {
+ continue
+ }
+
+ wasNull := value == nil && (field.Nullable || field.Default == nil)
+ value, err := b.convert(field.Type, value, op)
+ if err != nil {
+ return httperror.WrapFieldAPIError(err, httperror.INVALID_FORMAT, fieldName, err.Error())
+ }
+
+ if value != nil || wasNull {
+ if slice, ok := value.([]interface{}); ok {
+ for _, sliceValue := range slice {
+ if sliceValue == nil {
+ return httperror.NewFieldAPIError(httperror.NOT_NULLABLE, fieldName, "Individual array values can not be null")
+ }
+ if err := checkFieldCriteria(fieldName, field, sliceValue); err != nil {
+ return err
+ }
+ }
+ } else {
+ if err := checkFieldCriteria(fieldName, field, value); err != nil {
+ return err
+ }
+ }
+ result[fieldName] = value
+ }
+ }
+
+ return nil
+}
+
+func (b *Builder) checkDefaultAndRequired(schema *client.Schema, input map[string]interface{}, op Operation, result map[string]interface{}) error {
+ for fieldName, field := range schema.ResourceFields {
+ _, hasKey := result[fieldName]
+ if op == Create && !hasKey && field.Default != nil {
+ result[fieldName] = field.Default
+ }
+
+ _, hasKey = result[fieldName]
+ if op == Create && fieldMatchesOp(field, Create) && field.Required {
+ if !hasKey {
+ return httperror.NewFieldAPIError(httperror.MISSING_REQUIRED, fieldName, "")
+ }
+
+ if isArrayType(field.Type) {
+ slice, err := b.convertArray(fieldName, result[fieldName], op)
+ if err != nil {
+ return err
+ }
+ if len(slice) == 0 {
+ return httperror.NewFieldAPIError(httperror.MISSING_REQUIRED, fieldName, "")
+ }
+ }
+ }
+ }
+
+ return nil
+}
+
+func (b *Builder) copyFields(schema *client.Schema, input map[string]interface{}, op Operation) (map[string]interface{}, error) {
+ result := map[string]interface{}{}
+
+ if err := b.copyInputs(schema, input, op, result); err != nil {
+ return nil, err
+ }
+
+ return result, b.checkDefaultAndRequired(schema, input, op, result)
+}
+
+func checkFieldCriteria(fieldName string, field client.Field, value interface{}) error {
+ numVal, isNum := value.(int64)
+ strVal := ""
+ hasStrVal := false
+
+ if value == nil && field.Default != nil {
+ value = field.Default
+ }
+
+ if value != nil {
+ hasStrVal = true
+ strVal = fmt.Sprint(value)
+ }
+
+ if value == nil && !field.Nullable {
+ return httperror.NewFieldAPIError(httperror.NOT_NULLABLE, fieldName, "")
+ }
+
+ if isNum {
+ if field.Min != nil && numVal < *field.Min {
+ return httperror.NewFieldAPIError(httperror.MIN_LIMIT_EXCEEDED, fieldName, "")
+ }
+ if field.Max != nil && numVal > *field.Max {
+ return httperror.NewFieldAPIError(httperror.MAX_LIMIT_EXCEEDED, fieldName, "")
+ }
+ }
+
+ if hasStrVal {
+ if field.MinLength != nil && len(strVal) < *field.MinLength {
+ return httperror.NewFieldAPIError(httperror.MIN_LENGTH_EXCEEDED, fieldName, "")
+ }
+ if field.MaxLength != nil && len(strVal) > *field.MaxLength {
+ return httperror.NewFieldAPIError(httperror.MAX_LENGTH_EXCEEDED, fieldName, "")
+ }
+ }
+
+ if len(field.Options) > 0 {
+ if hasStrVal || !field.Nullable {
+ found := false
+ for _, option := range field.Options {
+ if strVal == option {
+ found = true
+ break
+ }
+ }
+
+ if !found {
+ httperror.NewFieldAPIError(httperror.INVALID_OPTION, fieldName, "")
+ }
+ }
+ }
+
+ if len(field.ValidChars) > 0 && hasStrVal {
+ for _, c := range strVal {
+ if !strings.ContainsRune(field.ValidChars, c) {
+ httperror.NewFieldAPIError(httperror.INVALID_CHARACTERS, fieldName, "")
+ }
+
+ }
+ }
+
+ if len(field.InvalidChars) > 0 && hasStrVal {
+ if strings.ContainsAny(strVal, field.InvalidChars) {
+ httperror.NewFieldAPIError(httperror.INVALID_CHARACTERS, fieldName, "")
+ }
+ }
+
+ return nil
+}
+
+func (b *Builder) convert(fieldType string, value interface{}, op Operation) (interface{}, error) {
+ if value == nil {
+ return value, nil
+ }
+
+ switch {
+ case isMapType(fieldType):
+ return b.convertMap(fieldType, value, op), nil
+ case isArrayType(fieldType):
+ return b.convertArray(fieldType, value, op), nil
+ case isReferenceType(fieldType):
+ return b.convertReferenceType(fieldType, value)
+ }
+
+ switch fieldType {
+ case "json":
+ return value, nil
+ case "date":
+ return convertString(value), nil
+ case "boolean":
+ return convertBool(value), nil
+ case "enum":
+ return convertString(value), nil
+ case "int":
+ return convertNumber(value)
+ case "password":
+ return convertString(value), nil
+ case "string":
+ return convertString(value), nil
+ case "reference":
+ return convertString(value), nil
+ }
+
+ return b.convertType(fieldType, value, op)
+}
+
+func (b *Builder) convertType(fieldType string, value interface{}, op Operation) (interface{}, error) {
+ schema := b.Registry.GetSchema(fieldType)
+ if schema == nil {
+ return nil, httperror.NewAPIError(httperror.INVALID_TYPE, "Failed to find type "+fieldType)
+ }
+
+ mapValue, ok := value.(map[string]interface{})
+ if !ok {
+ return nil, httperror.NewAPIError(httperror.INVALID_FORMAT, fmt.Sprintf("Value can not be converted to type %s: %v", fieldType, value))
+ }
+
+ return b.Construct(schema, mapValue, op)
+}
+
+func convertNumber(value interface{}) (int64, error) {
+ i, ok := value.(int64)
+ if ok {
+ return i, nil
+ }
+ return strconv.ParseInt(convertString(value), 10, 64)
+}
+
+func convertBool(value interface{}) bool {
+ b, ok := value.(bool)
+ if ok {
+ return b
+ }
+
+ str := strings.ToLower(convertString(value))
+ return str == "true" || str == "t" || str == "yes" || str == "y"
+}
+
+func convertString(value interface{}) string {
+ return fmt.Sprint(value)
+}
+
+func (b *Builder) convertReferenceType(fieldType string, value interface{}) (string, error) {
+ subType := fieldType[len("array[") : len(fieldType)-1]
+ strVal := convertString(value)
+ if !b.RefValidator.Validate(subType, strVal) {
+ return "", httperror.NewAPIError(httperror.INVALID_REFERENCE, fmt.Sprintf("Not found type: %s id: %s", subType, strVal))
+ }
+ return strVal, nil
+}
+
+func (b *Builder) convertArray(fieldType string, value interface{}, op Operation) ([]interface{}, error) {
+ sliceValue, ok := value.([]interface{})
+ if !ok {
+ return nil, nil
+ }
+
+ result := []interface{}{}
+ subType := fieldType[len("array[") : len(fieldType)-1]
+
+ for _, value := range sliceValue {
+ val, err := b.convert(subType, value, op)
+ if err != nil {
+ return nil, err
+ }
+ result = append(result, val)
+ }
+
+ return result, nil
+}
+
+func (b *Builder) convertMap(fieldType string, value interface{}, op Operation) (map[string]interface{}, error) {
+ mapValue, ok := value.(map[string]interface{})
+ if !ok {
+ return nil, nil
+ }
+
+ result := map[string]interface{}{}
+ subType := fieldType[len("map[") : len(fieldType)-1]
+
+ for key, value := range mapValue {
+ val, err := b.convert(subType, value, op)
+ if err != nil {
+ return nil, httperror.WrapAPIError(err, httperror.INVALID_FORMAT, err.Error())
+ }
+ result[key] = val
+ }
+
+ return result, nil
+}
+
+func isMapType(fieldType string) bool {
+ return strings.HasPrefix(fieldType, "map[") && strings.HasSuffix(fieldType, "]")
+}
+
+func isArrayType(fieldType string) bool {
+ return strings.HasPrefix(fieldType, "array[") && strings.HasSuffix(fieldType, "]")
+}
+
+func isReferenceType(fieldType string) bool {
+ return strings.HasPrefix(fieldType, "reference[") && strings.HasSuffix(fieldType, "]")
+}
+
+func fieldMatchesOp(field client.Field, op Operation) bool {
+ switch op {
+ case Create:
+ return field.Create
+ case Update:
+ return field.Update
+ default:
+ return false
+ }
+}
diff --git a/httperror/error.go b/httperror/error.go
new file mode 100644
index 00000000..fc260180
--- /dev/null
+++ b/httperror/error.go
@@ -0,0 +1,72 @@
+package httperror
+
+import (
+ "fmt"
+)
+
+var (
+ INVALID_DATE_FORMAT = ErrorCode("InvalidDateFormat")
+ INVALID_FORMAT = ErrorCode("InvalidFormat")
+ INVALID_REFERENCE = ErrorCode("InvalidReference")
+ NOT_NULLABLE = ErrorCode("NotNullable")
+ NOT_UNIQUE = ErrorCode("NotUnique")
+ MIN_LIMIT_EXCEEDED = ErrorCode("MinLimitExceeded")
+ MAX_LIMIT_EXCEEDED = ErrorCode("MaxLimitExceeded")
+ MIN_LENGTH_EXCEEDED = ErrorCode("MinLengthExceeded")
+ MAX_LENGTH_EXCEEDED = ErrorCode("MaxLengthExceeded")
+ INVALID_OPTION = ErrorCode("InvalidOption")
+ INVALID_CHARACTERS = ErrorCode("InvalidCharacters")
+ MISSING_REQUIRED = ErrorCode("MissingRequired")
+ INVALID_CSRF_TOKEN = ErrorCode("InvalidCSRFToken")
+ INVALID_ACTION = ErrorCode("InvalidAction")
+ INVALID_BODY_CONTENT = ErrorCode("InvalidBodyContent")
+ INVALID_TYPE = ErrorCode("InvalidType")
+ ACTION_NOT_AVAILABLE = ErrorCode("ActionNotAvailable")
+ INVALID_STATE = ErrorCode("InvalidState")
+ SERVER_ERROR = ErrorCode("ServerError")
+)
+
+type ErrorCode string
+
+type APIError struct {
+ code ErrorCode
+ message string
+ Cause error
+ fieldName string
+}
+
+func NewAPIError(code ErrorCode, message string) error {
+ return &APIError{
+ code: code,
+ message: message,
+ }
+}
+
+func NewFieldAPIError(code ErrorCode, fieldName, message string) error {
+ return &APIError{
+ code: code,
+ message: message,
+ fieldName: fieldName,
+ }
+}
+
+func WrapFieldAPIError(err error, code ErrorCode, fieldName, message string) error {
+ return &APIError{
+ Cause: err,
+ code: code,
+ message: message,
+ fieldName: fieldName,
+ }
+}
+
+func WrapAPIError(err error, code ErrorCode, message string) error {
+ return &APIError{
+ code: code,
+ message: message,
+ Cause: err,
+ }
+}
+
+func (a *APIError) Error() string {
+ return fmt.Sprintf("%s: %s", a.code, a.message)
+}
diff --git a/query/condition.go b/query/condition.go
new file mode 100644
index 00000000..fa4ac6b0
--- /dev/null
+++ b/query/condition.go
@@ -0,0 +1,82 @@
+package query
+
+var (
+ COND_EQ = ConditionType("eq")
+ COND_NE = ConditionType("ne")
+ COND_NULL = ConditionType("null")
+ COND_NOTNULL = ConditionType("notnull")
+ COND_IN = ConditionType("in")
+ COND_NOTIN = ConditionType("notin")
+ COND_OR = ConditionType("or")
+ COND_AND = ConditionType("AND")
+
+ mods = map[ConditionType]bool{
+ COND_EQ: true,
+ COND_NE: true,
+ COND_NULL: true,
+ COND_NOTNULL: true,
+ COND_IN: true,
+ COND_NOTIN: true,
+ COND_OR: true,
+ COND_AND: true,
+ }
+)
+
+type ConditionType string
+
+type Condition struct {
+ values []interface{}
+ conditionType ConditionType
+ left, right *Condition
+}
+
+func ValidMod(mod string) bool {
+ return mods[ConditionType(mod)]
+}
+
+func NewCondition(conditionType ConditionType, values ...interface{}) *Condition {
+ return &Condition{
+ values: values,
+ conditionType: conditionType,
+ }
+}
+
+func NE(value interface{}) *Condition {
+ return NewCondition(COND_NE, value)
+}
+
+func EQ(value interface{}) *Condition {
+ return NewCondition(COND_EQ, value)
+}
+
+func NULL(value interface{}) *Condition {
+ return NewCondition(COND_NULL)
+}
+
+func NOTNULL(value interface{}) *Condition {
+ return NewCondition(COND_NOTNULL)
+}
+
+func IN(values ...interface{}) *Condition {
+ return NewCondition(COND_IN, values...)
+}
+
+func NOTIN(values ...interface{}) *Condition {
+ return NewCondition(COND_NOTIN, values...)
+}
+
+func (c *Condition) AND(right *Condition) *Condition {
+ return &Condition{
+ conditionType: COND_AND,
+ left: c,
+ right: right,
+ }
+}
+
+func (c *Condition) OR(right *Condition) *Condition {
+ return &Condition{
+ conditionType: COND_OR,
+ left: c,
+ right: right,
+ }
+}
diff --git a/registry/registry.go b/registry/registry.go
new file mode 100644
index 00000000..1ed21fe0
--- /dev/null
+++ b/registry/registry.go
@@ -0,0 +1,7 @@
+package registry
+
+import "github.com/rancher/go-rancher/v3"
+
+type SchemaRegistry interface {
+ GetSchema(name string) *client.Schema
+}
diff --git a/store/reference.go b/store/reference.go
new file mode 100644
index 00000000..12937f18
--- /dev/null
+++ b/store/reference.go
@@ -0,0 +1,7 @@
+package store
+
+type ReferenceValidator interface {
+
+ Validate(resourceType, resourceID string) bool
+
+}
\ No newline at end of file
diff --git a/vendor/github.com/rancher/go-rancher/.dockerignore b/vendor/github.com/rancher/go-rancher/.dockerignore
new file mode 100644
index 00000000..6e43c2a9
--- /dev/null
+++ b/vendor/github.com/rancher/go-rancher/.dockerignore
@@ -0,0 +1,4 @@
+./bin
+./.dapper
+./dist
+./.trash-cache
diff --git a/vendor/github.com/rancher/go-rancher/.drone.yml b/vendor/github.com/rancher/go-rancher/.drone.yml
new file mode 100644
index 00000000..2d592c3e
--- /dev/null
+++ b/vendor/github.com/rancher/go-rancher/.drone.yml
@@ -0,0 +1,7 @@
+pipeline:
+ build:
+ image: rancher/dapper:1.10.3
+ volumes:
+ - /var/run/docker.sock:/var/run/docker.sock
+ commands:
+ - dapper ci
diff --git a/vendor/github.com/rancher/go-rancher/.gitignore b/vendor/github.com/rancher/go-rancher/.gitignore
new file mode 100644
index 00000000..81d1b990
--- /dev/null
+++ b/vendor/github.com/rancher/go-rancher/.gitignore
@@ -0,0 +1,5 @@
+/.dapper
+/bin
+/dist
+*.swp
+/.trash-cache
diff --git a/vendor/github.com/rancher/go-rancher/Dockerfile.dapper b/vendor/github.com/rancher/go-rancher/Dockerfile.dapper
new file mode 100644
index 00000000..d5bfad7a
--- /dev/null
+++ b/vendor/github.com/rancher/go-rancher/Dockerfile.dapper
@@ -0,0 +1,30 @@
+FROM ubuntu:16.04
+# FROM arm=armhf/ubuntu:16.04
+
+ARG DAPPER_HOST_ARCH=amd64
+ENV HOST_ARCH=${DAPPER_HOST_ARCH} ARCH=${DAPPER_HOST_ARCH}
+
+RUN apt-get update && \
+ apt-get install -y gcc ca-certificates git wget curl vim less file && \
+ rm -f /bin/sh && ln -s /bin/bash /bin/sh
+
+ENV GOLANG_ARCH_amd64=amd64 GOLANG_ARCH_arm=armv6l GOLANG_ARCH=GOLANG_ARCH_${ARCH} \
+ GOPATH=/go PATH=/go/bin:/usr/local/go/bin:${PATH} SHELL=/bin/bash
+
+ENV DOCKER_URL_amd64=https://get.docker.com/builds/Linux/x86_64/docker-1.10.3 \
+ DOCKER_URL_arm=https://github.com/rancher/docker/releases/download/v1.10.3-ros1/docker-1.10.3_arm \
+ DOCKER_URL=DOCKER_URL_${ARCH}
+RUN wget -O - ${!DOCKER_URL} > /usr/bin/docker && chmod +x /usr/bin/docker
+
+RUN wget -O - https://storage.googleapis.com/golang/go1.7.1.linux-${!GOLANG_ARCH}.tar.gz | tar -xzf - -C /usr/local && \
+ go get github.com/rancher/trash && go get github.com/golang/lint/golint
+
+ENV DAPPER_SOURCE /go/src/github.com/rancher/go-rancher/
+ENV DAPPER_OUTPUT ./bin
+ENV DAPPER_DOCKER_SOCKET true
+ENV TRASH_CACHE ${DAPPER_SOURCE}/.trash-cache
+ENV HOME ${DAPPER_SOURCE}
+WORKDIR ${DAPPER_SOURCE}
+
+ENTRYPOINT ["./scripts/entry"]
+CMD ["ci"]
diff --git a/vendor/github.com/rancher/go-rancher/LICENSE b/vendor/github.com/rancher/go-rancher/LICENSE
new file mode 100644
index 00000000..f433b1a5
--- /dev/null
+++ b/vendor/github.com/rancher/go-rancher/LICENSE
@@ -0,0 +1,177 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
diff --git a/vendor/github.com/rancher/go-rancher/Makefile b/vendor/github.com/rancher/go-rancher/Makefile
new file mode 100644
index 00000000..d7d72a16
--- /dev/null
+++ b/vendor/github.com/rancher/go-rancher/Makefile
@@ -0,0 +1,23 @@
+TARGETS := $(shell ls scripts)
+
+.dapper:
+ @echo Downloading dapper
+ @curl -sL https://releases.rancher.com/dapper/latest/dapper-`uname -s`-`uname -m` > .dapper.tmp
+ @@chmod +x .dapper.tmp
+ @./.dapper.tmp -v
+ @mv .dapper.tmp .dapper
+
+$(TARGETS): .dapper
+ ./.dapper $@
+
+trash: .dapper
+ ./.dapper -m bind trash
+
+trash-keep: .dapper
+ ./.dapper -m bind trash -k
+
+deps: trash
+
+.DEFAULT_GOAL := ci
+
+.PHONY: $(TARGETS)
diff --git a/vendor/github.com/rancher/go-rancher/README.md b/vendor/github.com/rancher/go-rancher/README.md
new file mode 100644
index 00000000..58e479a9
--- /dev/null
+++ b/vendor/github.com/rancher/go-rancher/README.md
@@ -0,0 +1,55 @@
+# Go Bindings for Rancher API
+
+# Generating Code
+First, you must have a master version of Rancher running. The best way to do this is:
+```sh
+docker run -p 8080:8080 -d rancher/server:master
+```
+
+Once Rancher is running, you can run the gen-schema.sh script:
+```sh
+./scripts/gen-schema.sh http://:8080
+
+# The default url is http://localhost:8080, so if rancher/server is listening on localhost, you can omit the url:
+./scripts/gen-schema.sh
+```
+
+This will add, remove, and modify go files appropriately. Submit a PR that includes *all* these changes.
+
+## Important caveats
+1. If you are running on macOS, you must have gnu-sed installed as sed for this to work properly.
+2. If you are running against cattle that is running out of an IDE and you don't have go-machine-service running (you probably don't), you'll see a number of unexpected removed or modified files like `generated_host.go` `generated_machine.go` and `generated_*config.go`.
+
+# Building
+
+```sh
+godep go build ./client
+```
+
+# Tests
+
+```sh
+godep go test ./client
+```
+# Contact
+For bugs, questions, comments, corrections, suggestions, etc., open an issue in
+ [rancher/rancher](//github.com/rancher/rancher/issues) with a title starting with `[go-rancher] `.
+
+Or just [click here](//github.com/rancher/rancher/issues/new?title=%5Bgo-rancher%5D%20) to create a new issue.
+
+
+# License
+Copyright (c) 2014-2015 [Rancher Labs, Inc.](http://rancher.com)
+
+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](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.
+
diff --git a/vendor/github.com/rancher/go-rancher/api/api.go b/vendor/github.com/rancher/go-rancher/api/api.go
new file mode 100644
index 00000000..267aee1a
--- /dev/null
+++ b/vendor/github.com/rancher/go-rancher/api/api.go
@@ -0,0 +1,161 @@
+package api
+
+import (
+ "encoding/json"
+ "errors"
+ "reflect"
+
+ "github.com/rancher/go-rancher/client"
+ v2client "github.com/rancher/go-rancher/v2"
+)
+
+func toMap(obj interface{}) (map[string]interface{}, error) {
+ result := map[string]interface{}{}
+ bytes, err := json.Marshal(obj)
+ if err != nil {
+ return result, err
+ }
+
+ err = json.Unmarshal(bytes, &result)
+ return result, err
+}
+
+func getEmbedded(obj interface{}, checkType reflect.Type) interface{} {
+ val := reflect.ValueOf(obj)
+ for val.Kind() == reflect.Ptr || val.Kind() == reflect.Interface {
+ val = val.Elem()
+ }
+
+ if val.Kind() != reflect.Struct {
+ panic("Passed type is not a struct got: " + val.Kind().String())
+ }
+
+ t := val.Type()
+ for i := 0; i < val.NumField(); i++ {
+ if t.Field(i).Anonymous && t.Field(i).Type == checkType {
+ if !val.Field(i).CanAddr() {
+ panic("Field " + t.Field(i).Name + " is not addressable, pass pointer")
+ }
+ return val.Field(i).Addr().Interface()
+ }
+ }
+
+ return nil
+}
+
+func getCollection(obj interface{}) interface{} {
+ val := getEmbedded(obj, reflect.TypeOf(client.Collection{}))
+ if val == nil {
+ val = getEmbedded(obj, reflect.TypeOf(v2client.Collection{}))
+ if val == nil {
+ return nil
+ }
+ }
+ return val
+}
+
+func getResource(obj interface{}) (*client.Resource, *v2client.Resource) {
+ r, ok := obj.(*client.Resource)
+ if ok {
+ return r, nil
+ }
+ rObj, ok := obj.(client.Resource)
+ if ok {
+ return &rObj, nil
+ }
+ v2r, ok := obj.(*v2client.Resource)
+ if ok {
+ return nil, v2r
+ }
+ v2rObj, ok := obj.(v2client.Resource)
+ if ok {
+ return nil, &v2rObj
+ }
+ val := getEmbedded(obj, reflect.TypeOf(client.Resource{}))
+ if val == nil {
+ val = getEmbedded(obj, reflect.TypeOf(v2client.Resource{}))
+ if val == nil {
+ return nil, nil
+ }
+ }
+ v1Resource, ok := val.(*client.Resource)
+ if ok {
+ return v1Resource, nil
+ }
+ return nil, val.(*v2client.Resource)
+}
+
+func CollectionToMap(obj interface{}, schemas *client.Schemas) (map[string]interface{}, []map[string]interface{}, error) {
+ result := map[string]interface{}{}
+ data := []map[string]interface{}{}
+ if obj == nil {
+ return result, data, nil
+ }
+
+ c := getCollection(obj)
+ if c == nil {
+ return result, data, errors.New("value is not a Collection")
+ }
+
+ val := reflect.ValueOf(obj)
+ if val.Kind() == reflect.Ptr {
+ val = val.Elem()
+ }
+
+ val = val.FieldByName("Data")
+ for i := 0; i < val.Len(); i++ {
+ obj := val.Index(i)
+ if obj.Kind() != reflect.Ptr && obj.Kind() != reflect.Interface {
+ obj = obj.Addr()
+ }
+ dataObj, err := ResourceToMap(obj.Interface(), schemas)
+ if err != nil {
+ return result, data, err
+ }
+
+ data = append(data, dataObj)
+ }
+
+ collectionMap, err := toMap(obj)
+ if err != nil {
+ return result, data, err
+ }
+
+ collectionMap["data"] = data
+ return collectionMap, data, nil
+}
+
+func ResourceToMap(obj interface{}, schemas *client.Schemas) (map[string]interface{}, error) {
+ var resourceType string
+ result := map[string]interface{}{}
+ if obj == nil {
+ return result, nil
+ }
+
+ v1resource, v2resource := getResource(obj)
+ if v1resource == nil && v2resource == nil {
+ return result, errors.New("value is not a Resource")
+ }
+
+ if v1resource != nil {
+ resourceType = v1resource.Type
+ } else {
+ resourceType = v2resource.Type
+ }
+
+ objMap, err := toMap(obj)
+ if err != nil {
+ return result, err
+ }
+
+ schema := schemas.Schema(resourceType)
+ for k, v := range objMap {
+ _, ok := schema.CheckField(k)
+ if !ok {
+ continue
+ }
+ result[k] = v
+ }
+
+ return result, nil
+}
diff --git a/vendor/github.com/rancher/go-rancher/api/context.go b/vendor/github.com/rancher/go-rancher/api/context.go
new file mode 100644
index 00000000..01125009
--- /dev/null
+++ b/vendor/github.com/rancher/go-rancher/api/context.go
@@ -0,0 +1,47 @@
+package api
+
+import (
+ "net/http"
+
+ "github.com/gorilla/context"
+ "github.com/rancher/go-rancher/client"
+)
+
+type key int
+
+const (
+ contextKey key = 0
+)
+
+type ApiContext struct {
+ r *http.Request
+ schemas *client.Schemas
+ UrlBuilder UrlBuilder
+ apiResponseWriter ApiResponseWriter
+ responseWriter http.ResponseWriter
+}
+
+func GetApiContext(r *http.Request) *ApiContext {
+ if rv := context.Get(r, contextKey); rv != nil {
+ return rv.(*ApiContext)
+ }
+ return nil
+}
+
+func CreateApiContext(rw http.ResponseWriter, r *http.Request, schemas *client.Schemas) error {
+ urlBuilder, err := NewUrlBuilder(r, schemas)
+ if err != nil {
+ return err
+ }
+
+ apiContext := &ApiContext{
+ r: r,
+ schemas: schemas,
+ UrlBuilder: urlBuilder,
+ apiResponseWriter: parseResponseType(r),
+ responseWriter: rw,
+ }
+
+ context.Set(r, contextKey, apiContext)
+ return nil
+}
diff --git a/vendor/github.com/rancher/go-rancher/api/handler.go b/vendor/github.com/rancher/go-rancher/api/handler.go
new file mode 100644
index 00000000..cc048ec2
--- /dev/null
+++ b/vendor/github.com/rancher/go-rancher/api/handler.go
@@ -0,0 +1,109 @@
+package api
+
+import (
+ "net/http"
+
+ "github.com/Sirupsen/logrus"
+ "github.com/gorilla/context"
+ "github.com/gorilla/mux"
+ "github.com/rancher/go-rancher/client"
+)
+
+func ApiHandler(schemas *client.Schemas, f http.Handler) http.Handler {
+ return context.ClearHandler(http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
+ if err := CreateApiContext(rw, r, schemas); err != nil {
+ logrus.WithField("err", err).Errorf("Failed to create API context")
+ rw.WriteHeader(500)
+ return
+ }
+
+ f.ServeHTTP(rw, r)
+ }))
+}
+
+func VersionsHandler(schemas *client.Schemas, versions ...string) http.Handler {
+ return ApiHandler(schemas, http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
+ apiContext := GetApiContext(r)
+
+ collection := client.GenericCollection{
+ Collection: client.Collection{
+ Links: map[string]string{},
+ },
+ Data: []interface{}{},
+ }
+
+ for i, version := range versions {
+ collection.Data = append(collection.Data, client.Resource{
+ Id: version,
+ Links: map[string]string{
+ SELF: apiContext.UrlBuilder.Version(version),
+ },
+ Type: "apiVersion",
+ })
+
+ if i == len(versions)-1 {
+ collection.Links[LATEST] = apiContext.UrlBuilder.Version(version)
+ }
+ }
+
+ apiContext.Write(&collection)
+ }))
+}
+
+func contains(list []string, item string) bool {
+ for _, i := range list {
+ if i == item {
+ return true
+ }
+ }
+ return false
+}
+
+func VersionHandler(schemas *client.Schemas, version string) http.Handler {
+ return ApiHandler(schemas, http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
+ apiContext := GetApiContext(r)
+
+ versionResource := client.Resource{
+ Id: version,
+ Type: "apiVersion",
+ Links: map[string]string{},
+ }
+
+ for _, schema := range schemas.Data {
+ if contains(schema.CollectionMethods, "GET") {
+ versionResource.Links[schema.PluralName] = apiContext.UrlBuilder.Collection(schema.Id)
+ }
+ }
+
+ apiContext.Write(&versionResource)
+ }))
+}
+
+func SchemasHandler(schemas *client.Schemas) http.Handler {
+ return ApiHandler(schemas, http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
+ apiContext := GetApiContext(r)
+ schemasCopy := *schemas
+ for i := range schemasCopy.Data {
+ populateSchema(apiContext, &schemasCopy.Data[i])
+ }
+ apiContext.Write(&schemasCopy)
+ }))
+}
+
+func populateSchema(apiContext *ApiContext, schema *client.Schema) {
+ if contains(schema.CollectionMethods, "GET") {
+ schema.Links["collection"] = apiContext.UrlBuilder.Collection(schema.Id)
+ }
+}
+
+func SchemaHandler(schemas *client.Schemas) http.Handler {
+ return ApiHandler(schemas, http.HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
+ apiContext := GetApiContext(r)
+
+ schema := schemas.Schema(mux.Vars(r)["id"])
+
+ populateSchema(apiContext, &schema)
+
+ apiContext.Write(&schema)
+ }))
+}
diff --git a/vendor/github.com/rancher/go-rancher/api/html_writer.go b/vendor/github.com/rancher/go-rancher/api/html_writer.go
new file mode 100644
index 00000000..8cb2d1b7
--- /dev/null
+++ b/vendor/github.com/rancher/go-rancher/api/html_writer.go
@@ -0,0 +1,78 @@
+package api
+
+import (
+ "encoding/json"
+ "net/http"
+ "strings"
+)
+
+const (
+ before = `
+
+`)
+ optionsRegexp *regexp.Regexp = regexp.MustCompile(``)
+)
+
+func generateDescriptionFile(emptyDesc bool, collectionOnly bool, showDesc bool, showActions bool, showResourceFields bool) error {
+ //func generateDescriptionFile(emptyDesc bool, collectionOnly bool) error {
+ schemas, err := readCattleSchema()
+
+ if err != nil {
+ return err
+ }
+
+ if err = readBlacklistFiles(); err != nil {
+ return err
+ }
+
+ genericDescMap := make(map[string]string)
+ err = readGenDescFile(genericDescMap)
+ if err != nil {
+ return err
+ }
+
+ for _, resourceSchema := range schemas.Data {
+ //Check if it's an invalid Resource Type
+ if blacklistTypes[resourceSchema.Id] {
+ continue
+ }
+ /*
+ //Only print out collection links for the collection yml
+ if collectionOnly {
+ // If it's not a collection or it's a blacklist Collection, skip
+ if _, isCollection := resourceSchema.Links["collection"]; !isCollection || isBlacklistCollection(resourceSchema.Id) {
+ continue
+ }
+ } else {
+ //Only add in actions and fields for non-collection only files
+ for actionName := range resourceSchema.ResourceActions {
+ if !isBlacklistAction(resourceSchema.Id, actionName) {
+ if emptyDesc {
+ resourceDescriptionsMap[resourceSchema.Id+"-resourceActions-"+actionName] = ""
+ //resourceDescriptionsMap[resourceSchema.Id+"-"+actionName] = ""
+ } else {
+ resourceDescriptionsMap[resourceSchema.Id+"-resourceActions-"+actionName] = "To " + actionName + " the " + resourceSchema.Id
+ }
+ }
+ }
+
+ for fieldName, field := range resourceSchema.ResourceFields {
+ if emptyDesc {
+ resourceDescriptionsMap[resourceSchema.Id+"-resourceFields-"+fieldName] = ""
+ //resourceDescriptionsMap[resourceSchema.Id+"-"+fieldName] = ""
+ } else {
+ //check if a generic desc exists
+ var description string
+ if genericDesc, ok := genericDescMap[fieldName]; ok {
+ description = descRegexp.ReplaceAllString(genericDesc, resourceSchema.Id)
+ description = optionsRegexp.ReplaceAllString(description, "["+strings.Join(field.Options, ", ")+"]")
+ }
+ //else {
+ //description = "The " + fieldName + " for the " + schema.Id
+ //}
+ resourceDescriptionsMap[resourceSchema.Id+"-resourceFields-"+fieldName] = description
+ }
+ }
+ }
+ resourceDescriptionsMap[resourceSchema.Id+"-description"] = ""
+ */
+
+ visibleCollection := false
+
+ // If it's a collection or not a blacklist Collection, set true
+ if _, isCollection := resourceSchema.Links["collection"]; isCollection && !isBlacklistCollection(resourceSchema.Id) {
+ visibleCollection = true
+ }
+
+ //Only print out collection links
+ if collectionOnly && !visibleCollection {
+ continue
+ }
+
+ if showDesc {
+ resourceDescriptionsMap[resourceSchema.Id+"-description"] = ""
+ }
+
+ if showActions {
+ for actionName := range resourceSchema.ResourceActions {
+ if !isBlacklistAction(resourceSchema.Id, actionName) {
+ if emptyDesc {
+ resourceDescriptionsMap[resourceSchema.Id+"-resourceActions-"+actionName] = ""
+ //resourceDescriptionsMap[resourceSchema.Id+"-"+actionName] = ""
+ } else {
+ resourceDescriptionsMap[resourceSchema.Id+"-resourceActions-"+actionName] = "To " + actionName + " the " + resourceSchema.Id
+ }
+ }
+ }
+ }
+
+ if showResourceFields {
+ for fieldName, field := range resourceSchema.ResourceFields {
+ if emptyDesc {
+ resourceDescriptionsMap[resourceSchema.Id+"-resourceFields-"+fieldName] = ""
+ //resourceDescriptionsMap[resourceSchema.Id+"-"+fieldName] = ""
+ } else {
+ //check if a generic desc exists
+ var description string
+ if genericDesc, ok := genericDescMap[fieldName]; ok {
+ description = descRegexp.ReplaceAllString(genericDesc, resourceSchema.Id)
+ description = optionsRegexp.ReplaceAllString(description, strings.Join(field.Options, ", "))
+ } else {
+ //if enum, show list of options
+ if field.Type == "enum" {
+ description = "The options are " + strings.Join(field.Options, ", ") + "."
+ }
+ //description = "The " + fieldName + " for the " + schema.Id
+ }
+ resourceDescriptionsMap[resourceSchema.Id+"-resourceFields-"+fieldName] = description
+ }
+ }
+ }
+ }
+
+ if err = setupDirectory(apiOutputDir); err != nil {
+ return err
+ }
+
+ var filePrefix string
+ if collectionOnly {
+ filePrefix = "blank_collection_"
+ } else if emptyDesc {
+ if showResourceFields && !showDesc && !showActions {
+ filePrefix = "valid_example_"
+ } else {
+ filePrefix = "blank_"
+ }
+ }
+
+ output, err := os.Create(path.Join(apiInputDir, "/schema-check/"+filePrefix+"api_description.yml"))
+ if err != nil {
+ return err
+ }
+
+ defer output.Close()
+
+ data := map[string]interface{}{
+ "descriptionMap": resourceDescriptionsMap,
+ }
+
+ typeTemplate, err := template.New("apiDescription.template").ParseFiles("./templates/apiDescription.template")
+ if err != nil {
+ return err
+ }
+
+ return typeTemplate.Execute(output, data)
+}
diff --git a/vendor/github.com/rancher/go-rancher/docs/api_doc_generator.go b/vendor/github.com/rancher/go-rancher/docs/api_doc_generator.go
new file mode 100644
index 00000000..80096415
--- /dev/null
+++ b/vendor/github.com/rancher/go-rancher/docs/api_doc_generator.go
@@ -0,0 +1,650 @@
+package main
+
+import (
+ "encoding/json"
+ "fmt"
+ "io/ioutil"
+ "os"
+ "path"
+ "regexp"
+ "strings"
+ "text/template"
+
+ yaml "gopkg.in/yaml.v2"
+
+ "github.com/rancher/go-rancher/client"
+)
+
+var (
+ commonFieldsMap map[string]bool
+ schemaMap map[string]client.Schema
+ referenceRegexp *regexp.Regexp = regexp.MustCompile(`reference\[([a-zA-Z]+)\]`)
+ descriptionsMap map[string]string
+ genericDescriptionsMap map[string]string
+)
+
+func init() {
+ commonFieldsMap = make(map[string]bool)
+ schemaMap = make(map[string]client.Schema)
+ descriptionsMap = make(map[string]string)
+ genericDescriptionsMap = make(map[string]string)
+}
+
+//APIField is to add in description and provide URL
+type APIField struct {
+ client.Field
+ Description string `json:"description"`
+ TypeURL string
+}
+
+type APIAction struct {
+ ResourceName string
+ Input ActionInput
+ Output string
+ Description string `json:"description"`
+ Method string
+ ActionURL string
+}
+
+type ActionInput struct {
+ Name string
+ FieldMap map[string]APIField
+ InputJSON string
+}
+
+func generateFiles() error {
+ schemas, err := readCattleSchema()
+
+ if err != nil {
+ return err
+ }
+
+ if err = readBlacklistFiles(); err != nil {
+ return err
+ }
+
+ if err = readInputFiles(); err != nil {
+ return err
+ }
+
+ if err = setupDirectory(apiOutputDir + "/" + *apiVersion + "/api-resources/"); err != nil {
+ return err
+ }
+
+ //Create a map of all resources but exclude the blacklist items
+
+ for _, resourceSchema := range schemas.Data {
+ //Filter out any blacklist types
+ if blacklistTypes[resourceSchema.Id] {
+ continue
+ }
+
+ //Create a new Resource Action Map to eliminate any blacklist actions
+ resourceActionMap := make(map[string]client.Action)
+
+ //Add in check if resourceAction should be should be visible
+ for resourceAction, resourceActionValue := range resourceSchema.ResourceActions {
+ if !isBlacklistAction(resourceSchema.Id, resourceAction) {
+ resourceActionMap[resourceAction] = resourceActionValue
+ }
+ }
+
+ //Update the resource actions to the new resource action map
+ resourceSchema.ResourceActions = resourceActionMap
+
+ if !isBlacklistCollection(resourceSchema.Id) {
+ for key := range resourceSchema.Resource.Links {
+ if key == "collection" {
+ //Add a link to show the resource for the visible pages
+ resourceSchema.Resource.Links["showResource"] = "true"
+ }
+ }
+ }
+
+ schemaMap[resourceSchema.Id] = resourceSchema
+ }
+
+ generateCollectionResourcePages()
+
+ for _, schema := range schemaMap {
+ //Add in check to show if collection should be visible and if actions should be shown
+ showActions := false
+
+ if _, ok := schema.Resource.Links["showResource"]; ok {
+ showActions = true
+ }
+
+ if err = generateIndividualDocs(schema, showActions); err != nil {
+ return err
+ }
+ }
+
+ return nil
+}
+
+func readInputFiles() error {
+
+ //Read API Description Files for All Resources
+ composeBytes, err := ioutil.ReadFile(apiInputDir + "/schema-check/api_description.yml")
+ if err != nil {
+ return err
+ }
+ //resourceDescriptionsMap = make(map[string]string)
+
+ if err = yaml.Unmarshal(composeBytes, &descriptionsMap); err != nil {
+ return err
+ }
+
+ //Read API Description for the Manual Descriptions
+ composeBytes, err = ioutil.ReadFile(apiInputDir + "/api_description_override_apiVersion.yml")
+ if err != nil {
+ return err
+ }
+
+ descriptionsOverrideMap := make(map[string]string)
+
+ if err = yaml.Unmarshal(composeBytes, descriptionsOverrideMap); err != nil {
+ return err
+ }
+
+ for key, desc := range descriptionsOverrideMap {
+ //if desc != "" {
+ descriptionsMap[key] = desc
+ //}
+ }
+
+ //Read API Description Files for Collection Only Resources
+ composeBytes, err = ioutil.ReadFile(apiInputDir + "/collection_api_description_apiVersion.yml")
+ if err != nil {
+ return err
+ }
+ collectionDescriptionsMap := make(map[string]string)
+
+ if err = yaml.Unmarshal(composeBytes, collectionDescriptionsMap); err != nil {
+ return err
+ }
+
+ for key, desc := range collectionDescriptionsMap {
+ //if desc != "" {
+ descriptionsMap[key] = desc
+ //}
+ }
+ //read yaml file to load the common fields
+ composeBytes, err = ioutil.ReadFile(apiInputDir + "/common_fields.yml")
+ if err != nil {
+ return err
+ }
+
+ if err = yaml.Unmarshal(composeBytes, &commonFieldsMap); err != nil {
+ return err
+ }
+
+ //read yaml file to load the generic description fields
+ composeBytes, err = ioutil.ReadFile(apiInputDir + "/generic_descriptions.yml")
+ if err != nil {
+ return err
+ }
+
+ return yaml.Unmarshal(composeBytes, &genericDescriptionsMap)
+}
+
+func generateCollectionResourcePages() error {
+ data := map[string]interface{}{
+ "schemaMap": schemaMap,
+ "version": version,
+ "language": language,
+ "layout": layout,
+ "apiVersion": apiVersion,
+ }
+
+ funcMap := template.FuncMap{
+ "getResourceDescription": getResourceDescription,
+ "capitalize": strings.Title,
+ }
+
+ //Create main page of collection resources
+ output, err := os.Create(path.Join(apiOutputDir, *apiVersion, "api-resources", "index.md"))
+
+ if err != nil {
+ return err
+ }
+
+ defer output.Close()
+
+ typeTemplate, err := template.New("apiHomePage.template").Funcs(funcMap).ParseFiles("./templates/apiHomePage.template")
+ if err != nil {
+ return err
+ }
+
+ if err = typeTemplate.Execute(output, data); err != nil {
+ return err
+ }
+
+ //Create Navigation Side Bar file for docs site
+ apiNavBarName := "rancher-api-" + *apiVersion + "-sidebar-" + *version + ".html"
+ fmt.Println(apiNavBarName)
+
+ output, err = os.Create(path.Join(apiOutputDir, apiNavBarName))
+
+ if err != nil {
+ return err
+ }
+
+ defer output.Close()
+
+ typeTemplate, err = template.New("apiNavBar.template").Funcs(funcMap).ParseFiles("./templates/apiNavBar.template")
+ if err != nil {
+ return err
+ }
+
+ if err = typeTemplate.Execute(output, data); err != nil {
+ return err
+ }
+
+ //Create operation-check file to look at what collection resources have create/update/delete
+ output, err = os.Create(path.Join(apiOutputDir, *apiVersion, "operations.yml"))
+
+ if err != nil {
+ return err
+ }
+
+ defer output.Close()
+
+ typeTemplate, err = template.New("apiOperationCheck.template").Funcs(funcMap).ParseFiles("./templates/apiOperationCheck.template")
+ if err != nil {
+ return err
+ }
+ return typeTemplate.Execute(output, data)
+}
+
+func generateIndividualDocs(schema client.Schema, showActions bool) error {
+ if err := setupDirectory(apiOutputDir + "/" + *apiVersion + "/api-resources/" + schema.Id); err != nil {
+ return err
+ }
+
+ output, err := os.Create(path.Join(apiOutputDir, *apiVersion, "api-resources", schema.Id, "index.md"))
+
+ if err != nil {
+ return err
+ }
+
+ defer output.Close()
+
+ data := map[string]interface{}{
+ "schemaId": schema.Id,
+ "resourceDescription": getResourceDescription(schema.Id),
+ "writeableFieldMap": getFieldMap(schema, !showActions, true, false),
+ "readOnlyFieldMap": getFieldMap(schema, !showActions, false, true),
+ "operationMap": getActionMap(schema, true),
+ "actionMap": getActionMap(schema, false),
+ "pluralName": schema.PluralName,
+ "version": version,
+ "apiVersion": apiVersion,
+ "language": language,
+ "layout": layout,
+ }
+
+ funcMap := template.FuncMap{
+ "getResourceDescription": getResourceDescription,
+ "capitalize": strings.Title,
+ }
+
+ var templateName string
+
+ if showActions {
+ templateName = "apiResource.template"
+ } else {
+ templateName = "apiActionInput.template"
+ }
+
+ typeTemplate, err := template.New(templateName).Funcs(funcMap).ParseFiles("./templates/" + templateName)
+ if err != nil {
+ return err
+ }
+
+ return typeTemplate.Execute(output, data)
+}
+
+func getResourceDescription(resourceID string) string {
+ var desc string
+
+ if updatedDesc, inDescMap := descriptionsMap[resourceID+"-description"]; inDescMap {
+ return updatedDesc
+ }
+
+ return desc
+}
+
+func getFieldMap(schema client.Schema, includeCommon bool, writeable bool, readOnly bool) map[string]APIField {
+ fieldMap := make(map[string]APIField)
+
+ for fieldName, field := range schema.ResourceFields {
+ // Skip any fields that are in the common field list
+ if !includeCommon && commonFieldsMap[fieldName] {
+ continue
+ } else if isBlacklistField(schema.Id, fieldName) {
+ continue
+ }
+
+ includeAPIField := false
+
+ if writeable {
+ if field.Create || field.Update {
+ includeAPIField = true
+ }
+ }
+ if readOnly {
+ if !field.Create && !field.Update {
+ includeAPIField = true
+ }
+ }
+
+ if includeAPIField {
+ apiField := APIField{}
+ apiField.Field = field
+ apiField.Description = getFieldDescription(schema.Id, fieldName, field)
+
+ if referenceRegexp.MatchString(field.Type) {
+ //put the link to the referenced field in the form
+ //[type]({{site.baseurl}}/rancher/{{page.version}}/{{page.lang}}/api/api-resources/type/)
+ apiField.TypeURL = getRefTypeURL(field.Type)
+ } else if strings.HasSuffix(field.Type, "]") {
+ //Update other types that have references to other resources
+ apiField.TypeURL = getTypeURL(field.Type)
+ } else if _, isResourceType := schemaMap[field.Type]; isResourceType {
+ apiField.TypeURL = "[" + field.Type + "]({{site.baseurl}}/rancher/{{page.version}}/{{page.lang}}/api/{{page.apiVersion}}/api-resources/" + field.Type + "/)"
+ }
+
+ if field.Default == nil {
+ apiField.Default = ""
+ }
+
+ fieldMap[fieldName] = apiField
+ }
+ }
+ return fieldMap
+}
+
+func getFieldDescription(resourceID string, fieldID string, field client.Field) string {
+ var desc string
+ //desc := "This is the " + fieldID + " field"
+
+ //If it's a generic Description, translate the and
+ if genDescription, isGenericDescription := genericDescriptionsMap[fieldID]; isGenericDescription {
+ desc = descRegexp.ReplaceAllString(genDescription, resourceID)
+ desc = optionsRegexp.ReplaceAllString(desc, strings.Join(field.Options, "`, `"))
+ return desc
+ }
+
+ if updatedDesc, inDescMap := descriptionsMap[resourceID+"-resourceField-"+fieldID]; inDescMap {
+ return updatedDesc
+ //if enum, show list of options
+ } else if field.Type == "enum" {
+ updatedDesc = "The options are `" + strings.Join(field.Options, "`, `") + "`."
+ return updatedDesc
+ }
+
+ return desc
+}
+
+func getRefTypeURL(input string) string {
+ return referenceRegexp.ReplaceAllString(input, "[$1]({{site.baseurl}}/rancher/{{page.version}}/{{page.lang}}/api/{{page.apiVersion}}/api-resources/$1/)")
+}
+
+func getTypeURL(typeInput string) string {
+ var stringSliceByOpenBracket []string
+ stringSliceByOpenBracket = strings.SplitAfter(typeInput, "[")
+
+ var resourceName string
+
+ for _, value := range stringSliceByOpenBracket {
+ if strings.Contains(value, "]") {
+ resourceName = strings.Replace(value, "]", "", -1)
+ }
+ }
+
+ if _, isResourceType := schemaMap[resourceName]; isResourceType {
+ urlResourceName := "[" + resourceName + "]({{site.baseurl}}/rancher/{{page.version}}/{{page.lang}}/api/{{page.apiVersion}}/api-resources/" + resourceName + "/)"
+ return strings.Replace(typeInput, resourceName, urlResourceName, -1)
+ }
+ return typeInput
+}
+
+func getActionMap(schema client.Schema, operationsActions bool) map[string]APIAction {
+ actionMap := make(map[string]APIAction)
+
+ if operationsActions {
+ //Check for create by looking for POST in collectionMethods
+ for _, method := range schema.CollectionMethods {
+ if method == postAPI {
+ //add create
+ apiAction := APIAction{}
+ apiAction.ResourceName = schema.Id
+ apiAction.Description = getActionDescription(schema.Id, "create")
+ apiAction.Method = postAPI
+ apiAction.ActionURL = "/" + *apiVersion + "/projects/${PROJECT_ID}/" + schema.PluralName
+ resourceFields := make(map[string]client.Field)
+
+ for fieldName, field := range schema.ResourceFields {
+ if field.Create {
+ resourceFields[fieldName] = field
+ }
+ }
+
+ //apiAction.Input.InputJSON = generateExampleJSONFromFields(schema.Id, resourceFields)
+ apiAction.Input.InputJSON = generateJSONFromFields(resourceFields)
+ actionMap["Create"] = apiAction
+ }
+ }
+
+ for _, method := range schema.ResourceMethods {
+ if method == "PUT" {
+ //add update
+ apiAction := APIAction{}
+ apiAction.ResourceName = schema.Id
+ apiAction.Description = getActionDescription(schema.Id, "update")
+ apiAction.Method = "PUT"
+ apiAction.ActionURL = "/" + *apiVersion + "/projects/${PROJECT_ID}/" + schema.PluralName + "/${ID}"
+ resourceFields := make(map[string]client.Field)
+
+ for fieldName, field := range schema.ResourceFields {
+ if field.Update {
+ resourceFields[fieldName] = field
+ }
+ }
+
+ //apiAction.Input.InputJSON = generateExampleJSONFromFields(schema.Id, resourceFields)
+ apiAction.Input.InputJSON = generateJSONFromFields(resourceFields)
+ actionMap["Update"] = apiAction
+ } else if method == "DELETE" {
+ //add delete
+ apiAction := APIAction{}
+ apiAction.ResourceName = schema.Id
+ apiAction.Description = getActionDescription(schema.Id, "delete")
+ apiAction.Method = "DELETE"
+ apiAction.ActionURL = "/" + *apiVersion + "/projects/${PROJECT_ID}/" + schema.PluralName + "/${ID}"
+ actionMap["Delete"] = apiAction
+ }
+ }
+
+ } else {
+
+ for actionName, action := range schema.ResourceActions {
+ //Check if general action or resource specific action is blacklisted
+ if isBlacklistAction(schema.Id, actionName) {
+ continue
+ }
+
+ apiAction := APIAction{}
+ apiAction.ResourceName = schema.Id
+ apiAction.Description = getActionDescription(schema.Id, actionName)
+ apiAction.Input = getActionInput(schema.Id, action.Input, true)
+ apiAction.Output = action.Output
+ apiAction.Method = postAPI
+ apiAction.ActionURL = "/" + *apiVersion + "/projects/${PROJECT_ID}/" + schema.PluralName + "/${ID}?action=" + actionName
+
+ actionMap[actionName] = apiAction
+ }
+ }
+
+ return actionMap
+}
+
+func getActionDescription(resourceID string, fieldID string) string {
+ var desc string
+ //desc := "This is the " + fieldID + " action"
+
+ if updatedDesc, inDescMap := descriptionsMap[resourceID+"-resourceAction-"+fieldID]; inDescMap {
+ return updatedDesc
+ }
+
+ return desc
+}
+
+func getActionInput(schemaID string, actionName string, includeCommonFields bool) ActionInput {
+ actionInput := ActionInput{}
+ actionInput.Name = actionName
+ actionInput.FieldMap = getFieldMap(schemaMap[actionName], includeCommonFields, true, true)
+ //actionInput.InputJSON = generateExampleJSONFromFields(schemaID, schemaMap[actionName].ResourceFields)
+ actionInput.InputJSON = generateJSONFromFields(schemaMap[actionName].ResourceFields)
+
+ return actionInput
+}
+
+func generateJSONFromFields(resourceFields map[string]client.Field) string {
+ j, err := json.MarshalIndent(generateFieldTypeMap(resourceFields), "", "\t")
+
+ if err != nil {
+ return err.Error()
+ }
+ return strings.Replace(string(j), """, "", -1)
+
+}
+
+func generateFieldTypeMap(resourceFields map[string]client.Field) map[string]interface{} {
+ fieldTypeJSONMap := make(map[string]interface{})
+ for fieldName, field := range resourceFields {
+ fieldTypeJSONMap[fieldName] = generateTypeValue(field)
+ }
+ return fieldTypeJSONMap
+}
+
+/*
+
+func generateFieldTypeMapRequired(resourceFields map[string]client.Field) map[string]interface{} {
+ fieldTypeJSONMap := make(map[string]interface{})
+ for fieldName, field := range resourceFields {
+ if field.Required {
+ fieldTypeJSONMap[fieldName] = generateTypeValue(field)
+ }
+ }
+ return fieldTypeJSONMap
+}
+
+/*
+
+func generateExampleJSONFromFields(schemaID string, resourceFields map[string]client.Field) string {
+ j, err := json.MarshalIndent(generateExampleFieldTypeMap(schemaID, resourceFields), "", "\t")
+
+ if err != nil {
+ return err.Error()
+ }
+ return strings.Replace(string(j), """, "", -1)
+
+}
+func generateExampleFieldTypeMap(schemaID string, resourceFields map[string]client.Field) map[string]interface{} {
+ fieldTypeJSONMap := make(map[string]interface{})
+ for fieldName, field := range resourceFields {
+ fieldTypeJSONMap[fieldName] = generateExampleTypeValue(schemaID, fieldName, field)
+ }
+ return fieldTypeJSONMap
+}
+
+func generateExampleTypeValue(schemaID string, fieldName string, field client.Field) interface{} {
+ //get default value if available
+ if field.Default != nil {
+ return field.Default
+ }
+
+ if schemaID == "service" {
+ fmt.Println(schemaID)
+ //Read JSON Files for All Resources
+ composeBytes, err := ioutil.ReadFile(apiInputDir + "/" + schemaID + "JSONExample.yml")
+ if err != nil {
+ return err
+ }
+
+ var exampleValues map[string]string
+ if err = json.Unmarshal(composeBytes, exampleValues); err != nil {
+ return err
+ }
+
+ for k, v := range exampleValues {
+ fmt.Println(k + v)
+ }
+ if exampleValues[fieldName] != "" {
+ fmt.Println(exampleValues[fieldName])
+ return exampleValues[fieldName]
+ }
+ }
+
+ //basic types
+ switch field.Type {
+ case "string":
+ return "string"
+ case "int":
+ return 0
+ case "boolean":
+ return false
+ case "array[string]":
+ return [...]string{"string1", "...stringN"}
+ case "map[string]":
+ return map[string]string{"key": "value-pairs"}
+ case "map[json]":
+ return map[string]string{"key": "value-pairs"}
+ case "password":
+ return field.Type
+ }
+
+ //another resourceType
+ subSchema, ok := schemaMap[field.Type]
+ if ok {
+ return generateExampleTypeValue(schemaID, fieldName, subSchema.ResourceFields)
+ }
+
+ return field.Type
+}
+*/
+
+func generateTypeValue(field client.Field) interface{} {
+ //get default value if available
+ if field.Default != nil {
+ return field.Default
+ }
+
+ //basic types
+ switch field.Type {
+ case "string":
+ return "string"
+ case "int":
+ return 0
+ case "boolean":
+ return false
+ case "array[string]":
+ return [...]string{"string1", "...stringN"}
+ case "map[string]":
+ return map[string]string{"key": "value-pairs"}
+ case "map[json]":
+ return map[string]string{"key": "value-pairs"}
+ case "password":
+ return field.Type
+ }
+
+ //another resourceType
+ subSchema, ok := schemaMap[field.Type]
+ if ok {
+ return generateFieldTypeMap(subSchema.ResourceFields)
+ }
+
+ return field.Type
+}
diff --git a/vendor/github.com/rancher/go-rancher/docs/input/api_description_override.yml b/vendor/github.com/rancher/go-rancher/docs/input/api_description_override.yml
new file mode 100644
index 00000000..078f3e9c
--- /dev/null
+++ b/vendor/github.com/rancher/go-rancher/docs/input/api_description_override.yml
@@ -0,0 +1,1585 @@
+account-description: All resources in Rancher are owned or created by an account.
+account-resourceActions-activate:
+account-resourceActions-deactivate:
+account-resourceFields-created: The date of when the was created.
+account-resourceFields-description:
+account-resourceFields-id: The unique identifier for the
+account-resourceFields-kind:
+account-resourceFields-name:
+account-resourceFields-removed: The date of when the was removed
+account-resourceFields-state: The current state of the . The options are .
+account-resourceFields-transitioning: Whether or not the is in a transitioning state
+account-resourceFields-transitioningMessage: The message to show while in a transitioning state
+account-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+account-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+activeSetting-description:
+activeSetting-resourceFields-activeValue:
+activeSetting-resourceFields-id: The unique identifier for the
+activeSetting-resourceFields-name:
+activeSetting-resourceFields-value:
+addOutputsInput-description:
+addOutputsInput-resourceFields-outputs:
+addRemoveLoadBalancerServiceLinkInput-description:
+addRemoveLoadBalancerServiceLinkInput-resourceFields-serviceLink:
+addRemoveServiceLinkInput-description:
+addRemoveServiceLinkInput-resourceFields-serviceLink:
+amazonec2Config-description: The configuration to launch an EC2 instance in Amazon Web Services using [machine]({{site.baseurl}}/rancher/{{page.version}}/{{page.lang}}/api/api-resources/machine). Rancher is calling `docker-machine`, so any available options in `docker-machine` for specific drivers are exposed in Rancher. The default fields from `docker-machine` are not listed in the Rancher API, and they can be found in the `docker-machine` documentation. The notes on which fields are **required** are from the `docker-machine` documentation.
+amazonec2Config-resourceFields-accessKey: required Your access key id for the Amazon Web Services API
+amazonec2Config-resourceFields-ami: The AMI ID of the instance to use
+amazonec2Config-resourceFields-deviceName:
+amazonec2Config-resourceFields-iamInstanceProfile: The AWS IAM instance role name to be used as the instance profile
+amazonec2Config-resourceFields-instanceType: The AWS instance type to run
+amazonec2Config-resourceFields-monitoring: Whether or not to enable CloudWatch Monitoring
+amazonec2Config-resourceFields-privateAddressOnly: Whether or not to use the AWS EC2 private IP address
+amazonec2Config-resourceFields-region: The region to use when launching the instance.
+amazonec2Config-resourceFields-requestSpotInstance: Whether or not to use AWS EC2 spot instances
+amazonec2Config-resourceFields-rootSize: The root disk size of the AWS EC2 instance (in GB)
+amazonec2Config-resourceFields-secretKey: required Your secret access key for the Amazon Web Services API
+amazonec2Config-resourceFields-securityGroup: The AWS VPC security group name to use when launching your instance
+amazonec2Config-resourceFields-sessionToken: The session token for the AWS API
+amazonec2Config-resourceFields-spotPrice: The spot instance bid price (in dollars) if the `requestSpotInstance` is `true`.
+amazonec2Config-resourceFields-sshKeypath:
+amazonec2Config-resourceFields-sshUser: The SSH login user name
+amazonec2Config-resourceFields-subnetId: The AWS VPC subnet ID
+amazonec2Config-resourceFields-tags:
+amazonec2Config-resourceFields-useEbsOptimizedInstance:
+amazonec2Config-resourceFields-usePrivateAddress: Whether or not to use the AWS EC2 private IP address
+amazonec2Config-resourceFields-volumeType:
+amazonec2Config-resourceFields-vpcId: required The VPC ID to launch the instance in
+amazonec2Config-resourceFields-zone: The AWS zone to launch the instance in (i.e. one of a, b, c, d, e)
+apiKey-description: An API Key provides access to the Rancher API if access control has been turned on. The access key and secret key pair are created per environment and can be used to directly call the API or used with [rancher-compose]({{site.baseurl}}/rancher/{{page.version}}/{{page.lang}}/rancher-compose).
+apiKey-resourceActions-activate:
+apiKey-resourceActions-deactivate:
+apiKey-resourceFields-accountId: The unique identifier for the associated account
+apiKey-resourceFields-created: The date of when the was created.
+apiKey-resourceFields-description:
+apiKey-resourceFields-id: The unique identifier for the
+apiKey-resourceFields-kind:
+apiKey-resourceFields-name:
+apiKey-resourceFields-publicValue: The public value of the
+apiKey-resourceFields-removed: The date of when the was removed
+apiKey-resourceFields-secretValue: The secret value of the
+apiKey-resourceFields-state: The current state of the . The options are .
+apiKey-resourceFields-transitioning: Whether or not the is in a transitioning state
+apiKey-resourceFields-transitioningMessage: The message to show while in a transitioning state
+apiKey-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+apiKey-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+auditLog-description:
+auditLog-resourceFields-accountId: The unique identifier for the associated account
+auditLog-resourceFields-authType:
+auditLog-resourceFields-authenticatedAsAccountId:
+auditLog-resourceFields-authenticatedAsIdentityId:
+auditLog-resourceFields-clientIp:
+auditLog-resourceFields-created: The date of when the was created.
+auditLog-resourceFields-description:
+auditLog-resourceFields-eventType:
+auditLog-resourceFields-id: The unique identifier for the
+auditLog-resourceFields-kind:
+auditLog-resourceFields-requestObject:
+auditLog-resourceFields-resourceId:
+auditLog-resourceFields-resourceType:
+auditLog-resourceFields-responseCode:
+auditLog-resourceFields-responseObject:
+azureConfig-description: The configuration to launch an instance in Microsoft Azure. For all cloud providers, Rancher is calling `docker-machine`, so any available options in `docker-machine` are exposed in Rancher. The default fields from `docker-machine` are not listed in the Rancher API, and they can be found in the `docker-machine` documentation.
+azureConfig-resourceFields-dockerPort: The port to use for the Docker daemon
+azureConfig-resourceFields-dockerSwarmMasterPort:
+azureConfig-resourceFields-image: The Azure image name
+azureConfig-resourceFields-location: The Azure machine instance location
+azureConfig-resourceFields-password: Your Azure password
+azureConfig-resourceFields-publishSettingsFile: The Azure setting file
+azureConfig-resourceFields-size: The Azure disk size
+azureConfig-resourceFields-sshPort: The Azure SSH port
+azureConfig-resourceFields-subscriptionCert: required The Azure subscription certificate
+azureConfig-resourceFields-subscriptionId: required The Azure subscription ID (ie. A GUID like`d255d8d7-5af0-4f5c-8a3e-1545044b861e`)
+azureConfig-resourceFields-username: Your Azure login user name
+backup-description:
+backup-resourceFields-accountId: The unique identifier for the associated account
+backup-resourceFields-backupTargetId:
+backup-resourceFields-created: The date of when the was created.
+backup-resourceFields-description:
+backup-resourceFields-id: The unique identifier for the
+backup-resourceFields-kind:
+backup-resourceFields-name:
+backup-resourceFields-removed: The date of when the was removed
+backup-resourceFields-snapshotId:
+backup-resourceFields-state: The current state of the . The options are .
+backup-resourceFields-transitioning: Whether or not the is in a transitioning state
+backup-resourceFields-transitioningMessage: The message to show while in a transitioning state
+backup-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+backup-resourceFields-uri:
+backup-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+backup-resourceFields-volumeId:
+backupTarget-description:
+backupTarget-resourceFields-accountId: The unique identifier for the associated account
+backupTarget-resourceFields-created: The date of when the was created.
+backupTarget-resourceFields-description:
+backupTarget-resourceFields-id: The unique identifier for the
+backupTarget-resourceFields-kind:
+backupTarget-resourceFields-name:
+backupTarget-resourceFields-nfsConfig:
+backupTarget-resourceFields-removed: The date of when the was removed
+backupTarget-resourceFields-state: The current state of the . The options are .
+backupTarget-resourceFields-transitioning: Whether or not the is in a transitioning state
+backupTarget-resourceFields-transitioningMessage: The message to show while in a transitioning state
+backupTarget-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+backupTarget-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+baseMachineConfig-description:
+blkioDeviceOption-description:
+blkioDeviceOption-resourceFields-readBps:
+blkioDeviceOption-resourceFields-readIops:
+blkioDeviceOption-resourceFields-weight:
+blkioDeviceOption-resourceFields-writeBps:
+blkioDeviceOption-resourceFields-writeIops:
+certificate-description: A certificate is used to add in SSL termination to load balancers.
+certificate-resourceFields-CN:
+certificate-resourceFields-accountId: The unique identifier for the associated account
+certificate-resourceFields-algorithm:
+certificate-resourceFields-cert:
+certificate-resourceFields-certChain:
+certificate-resourceFields-certFingerprint:
+certificate-resourceFields-created: The date of when the was created.
+certificate-resourceFields-description:
+certificate-resourceFields-expiresAt:
+certificate-resourceFields-id: The unique identifier for the
+certificate-resourceFields-issuedAt:
+certificate-resourceFields-issuer:
+certificate-resourceFields-key:
+certificate-resourceFields-keySize:
+certificate-resourceFields-kind:
+certificate-resourceFields-name:
+certificate-resourceFields-removed: The date of when the was removed
+certificate-resourceFields-serialNumber:
+certificate-resourceFields-state: The current state of the . The options are .
+certificate-resourceFields-subjectAlternativeNames:
+certificate-resourceFields-transitioning: Whether or not the is in a transitioning state
+certificate-resourceFields-transitioningMessage: The message to show while in a transitioning state
+certificate-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+certificate-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+certificate-resourceFields-version:
+changeSecretInput-description:
+changeSecretInput-resourceFields-newSecret:
+changeSecretInput-resourceFields-oldSecret:
+composeConfig-description:
+composeConfig-resourceFields-dockerComposeConfig:
+composeConfig-resourceFields-rancherComposeConfig:
+composeConfigInput-description:
+composeConfigInput-resourceFields-serviceIds:
+composeProject-description:
+composeProject-resourceActions-cancelrollback:
+composeProject-resourceActions-cancelupgrade:
+composeProject-resourceActions-error:
+composeProject-resourceActions-finishupgrade:
+composeProject-resourceActions-rollback:
+composeProject-resourceFields-accountId: The unique identifier for the associated account
+composeProject-resourceFields-created: The date of when the was created.
+composeProject-resourceFields-description:
+composeProject-resourceFields-environment:
+composeProject-resourceFields-externalId:
+composeProject-resourceFields-healthState:
+composeProject-resourceFields-id: The unique identifier for the
+composeProject-resourceFields-kind:
+composeProject-resourceFields-name:
+composeProject-resourceFields-previousEnvironment:
+composeProject-resourceFields-previousExternalId:
+composeProject-resourceFields-removed: The date of when the was removed
+composeProject-resourceFields-state: The current state of the . The options are .
+composeProject-resourceFields-templates:
+composeProject-resourceFields-transitioning: Whether or not the is in a transitioning state
+composeProject-resourceFields-transitioningMessage: The message to show while in a transitioning state
+composeProject-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+composeProject-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+composeService-description:
+composeService-resourceActions-activate:
+composeService-resourceActions-cancelrollback:
+composeService-resourceActions-cancelupgrade:
+composeService-resourceActions-finishupgrade:
+composeService-resourceActions-rollback:
+composeService-resourceFields-accountId: The unique identifier for the associated account
+composeService-resourceFields-created: The date of when the was created.
+composeService-resourceFields-currentScale:
+composeService-resourceFields-description:
+composeService-resourceFields-environmentId:
+composeService-resourceFields-externalId:
+composeService-resourceFields-fqdn:
+composeService-resourceFields-healthState:
+composeService-resourceFields-id: The unique identifier for the
+composeService-resourceFields-kind:
+composeService-resourceFields-launchConfig:
+composeService-resourceFields-name:
+composeService-resourceFields-publicEndpoints:
+composeService-resourceFields-removed: The date of when the was removed
+composeService-resourceFields-scale:
+composeService-resourceFields-scalePolicy:
+composeService-resourceFields-selectorContainer:
+composeService-resourceFields-selectorLink:
+composeService-resourceFields-startOnCreate:
+composeService-resourceFields-state: The current state of the . The options are .
+composeService-resourceFields-transitioning: Whether or not the is in a transitioning state
+composeService-resourceFields-transitioningMessage: The message to show while in a transitioning state
+composeService-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+composeService-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+composeService-resourceFields-vip:
+container-description: A container is a representation of a Docker container on a host.
+container-resourceActions-console:
+container-resourceActions-execute:
+container-resourceActions-logs:
+container-resourceActions-proxy:
+container-resourceActions-restart:
+container-resourceActions-start:
+container-resourceActions-stop:
+container-resourceFields-accountId: The unique identifier for the associated account
+container-resourceFields-blkioDeviceOptions:
+container-resourceFields-build:
+container-resourceFields-capAdd:
+container-resourceFields-capDrop:
+container-resourceFields-command: Overwrite the default commands set by the image
+container-resourceFields-count:
+container-resourceFields-cpuSet:
+container-resourceFields-cpuShares:
+container-resourceFields-createIndex:
+container-resourceFields-created: The date of when the was created.
+container-resourceFields-dataVolumeMounts:
+container-resourceFields-dataVolumes:
+container-resourceFields-dataVolumesFrom:
+container-resourceFields-deploymentUnitUuid:
+container-resourceFields-description:
+container-resourceFields-devices:
+container-resourceFields-dns:
+container-resourceFields-dnsSearch:
+container-resourceFields-domainName:
+container-resourceFields-entryPoint:
+container-resourceFields-environment:
+container-resourceFields-expose:
+container-resourceFields-externalId:
+container-resourceFields-extraHosts:
+container-resourceFields-firstRunning:
+container-resourceFields-healthCheck:
+container-resourceFields-healthState:
+container-resourceFields-hostId: The unique identifier for the associated host
+container-resourceFields-hostname:
+container-resourceFields-id: The unique identifier for the
+container-resourceFields-imageUuid:
+container-resourceFields-instanceLinks:
+container-resourceFields-kind:
+container-resourceFields-labels: A map of key value pairs to be used as labels for the
+container-resourceFields-logConfig:
+container-resourceFields-lxcConf:
+container-resourceFields-memory:
+container-resourceFields-memorySwap:
+container-resourceFields-name:
+container-resourceFields-nativeContainer:
+container-resourceFields-networkContainerId:
+container-resourceFields-networkIds:
+container-resourceFields-networkMode:
+container-resourceFields-pidMode:
+container-resourceFields-ports:
+container-resourceFields-primaryIpAddress:
+container-resourceFields-privileged:
+container-resourceFields-publishAllPorts:
+container-resourceFields-readOnly:
+container-resourceFields-registryCredentialId:
+container-resourceFields-removed: The date of when the was removed
+container-resourceFields-requestedHostId:
+container-resourceFields-restartPolicy:
+container-resourceFields-securityOpt:
+container-resourceFields-startCount:
+container-resourceFields-startOnCreate:
+container-resourceFields-state: The current state of the . The options are .
+container-resourceFields-stdinOpen:
+container-resourceFields-systemContainer:
+container-resourceFields-transitioning: Whether or not the is in a transitioning state
+container-resourceFields-transitioningMessage: The message to show while in a transitioning state
+container-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+container-resourceFields-tty:
+container-resourceFields-user:
+container-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+container-resourceFields-version:
+container-resourceFields-volumeDriver:
+container-resourceFields-workingDir:
+containerEvent-description:
+containerEvent-resourceFields-accountId: The unique identifier for the associated account
+containerEvent-resourceFields-created: The date of when the was created.
+containerEvent-resourceFields-dockerInspect:
+containerEvent-resourceFields-externalFrom:
+containerEvent-resourceFields-externalId:
+containerEvent-resourceFields-externalStatus:
+containerEvent-resourceFields-externalTimestamp:
+containerEvent-resourceFields-hostId: The unique identifier for the associated host
+containerEvent-resourceFields-id: The unique identifier for the
+containerEvent-resourceFields-kind:
+containerEvent-resourceFields-reportedHostUuid:
+containerEvent-resourceFields-state: The current state of the . The options are .
+containerEvent-resourceFields-transitioning: Whether or not the is in a transitioning state
+containerEvent-resourceFields-transitioningMessage: The message to show while in a transitioning state
+containerEvent-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+containerExec-description:
+containerExec-resourceFields-attachStdin:
+containerExec-resourceFields-attachStdout:
+containerExec-resourceFields-command: Overwrite the default commands set by the image
+containerExec-resourceFields-tty:
+containerLogs-description:
+containerLogs-resourceFields-follow:
+containerLogs-resourceFields-lines:
+containerProxy-description:
+containerProxy-resourceFields-port:
+containerProxy-resourceFields-scheme:
+credential-description:
+credential-resourceActions-activate:
+credential-resourceActions-deactivate:
+credential-resourceFields-accountId: The unique identifier for the associated account
+credential-resourceFields-created: The date of when the was created.
+credential-resourceFields-description:
+credential-resourceFields-id: The unique identifier for the
+credential-resourceFields-kind:
+credential-resourceFields-name:
+credential-resourceFields-publicValue: The public value of the
+credential-resourceFields-removed: The date of when the was removed
+credential-resourceFields-secretValue: The secret value of the
+credential-resourceFields-state: The current state of the . The options are .
+credential-resourceFields-transitioning: Whether or not the is in a transitioning state
+credential-resourceFields-transitioningMessage: The message to show while in a transitioning state
+credential-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+credential-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+digitaloceanConfig-description: The configuration to launch a droplet in DigitalOcean using [machine]({{site.baseurl}}/rancher/{{page.version}}/{{page.lang}}/api/api-resources/machine). Rancher is calling `docker-machine`, so any available options in `docker-machine` for specific drivers are exposed in Rancher. The default fields from `docker-machine` are not listed in the Rancher API, and they can be found in the `docker-machine` documentation.
+digitaloceanConfig-resourceFields-accessToken: required Your personal access token for the Digital Ocean API
+digitaloceanConfig-resourceFields-backups: Whether or not to enable Digital Oceans backups for the droplet
+digitaloceanConfig-resourceFields-image: The name of the Digital Ocean image to use
+digitaloceanConfig-resourceFields-ipv6: Whether or not to enable IPv6 support for the droplet
+digitaloceanConfig-resourceFields-privateNetworking: Whether or not to enable private networking support for the droplet
+digitaloceanConfig-resourceFields-region: The region to create the droplet in
+digitaloceanConfig-resourceFields-size: The size of the Digital Ocean droplet (larger than the default option (`512mb`) are of the form `2gb`)
+digitaloceanConfig-resourceFields-sshPort: The port to ssh into the host
+digitaloceanConfig-resourceFields-sshUser: The ssh username to use to ssh into the host
+digitaloceanConfig-resourceFields-userdata:
+dnsService-description: A "dnsService" in the API is referred to as a Service Alias in the UI and the Rancher documentation. In the API documentation, we'll use the UI terminology. A service alias allows the ability to add a DNS record for your services to be discovered.
+dnsService-resourceActions-activate:
+dnsService-resourceActions-deactivate:
+dnsService-resourceActions-removeservicelink:
+dnsService-resourceActions-rollback:
+dnsService-resourceActions-setservicelinks:
+dnsService-resourceActions-upgrade:
+dnsService-resourceFields-accountId: The unique identifier for the associated account
+dnsService-resourceFields-assignServiceIpAddress:
+dnsService-resourceFields-created: The date of when the was created.
+dnsService-resourceFields-description:
+dnsService-resourceFields-environmentId:
+dnsService-resourceFields-externalId:
+dnsService-resourceFields-fqdn:
+dnsService-resourceFields-healthState:
+dnsService-resourceFields-id: The unique identifier for the
+dnsService-resourceFields-kind:
+dnsService-resourceFields-launchConfig:
+dnsService-resourceFields-metadata:
+dnsService-resourceFields-name:
+dnsService-resourceFields-removed: The date of when the was removed
+dnsService-resourceFields-retainIp:
+dnsService-resourceFields-selectorLink:
+dnsService-resourceFields-startOnCreate:
+dnsService-resourceFields-state: The current state of the . The options are .
+dnsService-resourceFields-transitioning: Whether or not the is in a transitioning state
+dnsService-resourceFields-transitioningMessage: The message to show while in a transitioning state
+dnsService-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+dnsService-resourceFields-upgrade:
+dnsService-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+dockerBuild-description:
+dockerBuild-resourceFields-context:
+dockerBuild-resourceFields-dockerfile:
+dockerBuild-resourceFields-forcerm:
+dockerBuild-resourceFields-nocache:
+dockerBuild-resourceFields-remote:
+dockerBuild-resourceFields-rm:
+environment-description: An "environment" in the API is referred to as a stack in the UI and the Rancher documentation. In the API documentation, we'll use the UI terminology. A Rancher stack mirrors the same concept as a docker-compose project. It represents a group of services that make up a typical application or workload.
+environment-resourceActions-activateservices:
+environment-resourceActions-cancelrollback:
+environment-resourceActions-cancelupgrade:
+environment-resourceActions-deactivateservices:
+environment-resourceActions-exportconfig:
+environment-resourceActions-finishupgrade:
+environment-resourceActions-rollback:
+environment-resourceFields-accountId: The unique identifier for the associated account
+environment-resourceFields-created: The date of when the was created.
+environment-resourceFields-description:
+environment-resourceFields-dockerCompose:
+environment-resourceFields-environment:
+environment-resourceFields-externalId:
+environment-resourceFields-healthState:
+environment-resourceFields-id: The unique identifier for the
+environment-resourceFields-kind:
+environment-resourceFields-name:
+environment-resourceFields-outputs:
+environment-resourceFields-previousEnvironment:
+environment-resourceFields-previousExternalId:
+environment-resourceFields-rancherCompose:
+environment-resourceFields-removed: The date of when the was removed
+environment-resourceFields-startOnCreate:
+environment-resourceFields-state: The current state of the . The options are .
+environment-resourceFields-transitioning: Whether or not the is in a transitioning state
+environment-resourceFields-transitioningMessage: The message to show while in a transitioning state
+environment-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+environment-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+environmentUpgrade-description:
+environmentUpgrade-resourceFields-dockerCompose:
+environmentUpgrade-resourceFields-environment:
+environmentUpgrade-resourceFields-externalId:
+environmentUpgrade-resourceFields-rancherCompose:
+externalDnsEvent-description:
+externalDnsEvent-resourceFields-accountId: The unique identifier for the associated account
+externalDnsEvent-resourceFields-created: The date of when the was created.
+externalDnsEvent-resourceFields-eventType:
+externalDnsEvent-resourceFields-externalId:
+externalDnsEvent-resourceFields-fqdn:
+externalDnsEvent-resourceFields-id: The unique identifier for the
+externalDnsEvent-resourceFields-kind:
+externalDnsEvent-resourceFields-reportedAccountId:
+externalDnsEvent-resourceFields-serviceName:
+externalDnsEvent-resourceFields-stackName:
+externalDnsEvent-resourceFields-state: The current state of the . The options are .
+externalDnsEvent-resourceFields-transitioning: Whether or not the is in a transitioning state
+externalDnsEvent-resourceFields-transitioningMessage: The message to show while in a transitioning state
+externalDnsEvent-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+externalDnsEvent-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+externalEvent-description:
+externalEvent-resourceFields-accountId: The unique identifier for the associated account
+externalEvent-resourceFields-created: The date of when the was created.
+externalEvent-resourceFields-eventType:
+externalEvent-resourceFields-externalId:
+externalEvent-resourceFields-id: The unique identifier for the
+externalEvent-resourceFields-kind:
+externalEvent-resourceFields-reportedAccountId:
+externalEvent-resourceFields-state: The current state of the . The options are .
+externalEvent-resourceFields-transitioning: Whether or not the is in a transitioning state
+externalEvent-resourceFields-transitioningMessage: The message to show while in a transitioning state
+externalEvent-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+externalEvent-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+externalHostEvent-description:
+externalHostEvent-resourceFields-accountId: The unique identifier for the associated account
+externalHostEvent-resourceFields-created: The date of when the was created.
+externalHostEvent-resourceFields-deleteHost:
+externalHostEvent-resourceFields-eventType:
+externalHostEvent-resourceFields-externalId:
+externalHostEvent-resourceFields-hostId: The unique identifier for the associated host
+externalHostEvent-resourceFields-hostLabel:
+externalHostEvent-resourceFields-id: The unique identifier for the
+externalHostEvent-resourceFields-kind:
+externalHostEvent-resourceFields-reportedAccountId:
+externalHostEvent-resourceFields-state: The current state of the . The options are .
+externalHostEvent-resourceFields-transitioning: Whether or not the is in a transitioning state
+externalHostEvent-resourceFields-transitioningMessage: The message to show while in a transitioning state
+externalHostEvent-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+externalHostEvent-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+externalService-description: An external service allows the ability to add any IP or hostname as a service to be discovered as a service.
+externalService-resourceActions-activate:
+externalService-resourceActions-cancelrollback:
+externalService-resourceActions-cancelupgrade:
+externalService-resourceActions-deactivate:
+externalService-resourceActions-finishupgrade:
+externalService-resourceActions-rollback:
+externalService-resourceActions-upgrade:
+externalService-resourceFields-accountId: The unique identifier for the associated account
+externalService-resourceFields-created: The date of when the was created.
+externalService-resourceFields-description:
+externalService-resourceFields-environmentId:
+externalService-resourceFields-externalId:
+externalService-resourceFields-externalIpAddresses:
+externalService-resourceFields-fqdn:
+externalService-resourceFields-healthCheck:
+externalService-resourceFields-healthState:
+externalService-resourceFields-hostname:
+externalService-resourceFields-id: The unique identifier for the
+externalService-resourceFields-kind:
+externalService-resourceFields-launchConfig:
+externalService-resourceFields-metadata:
+externalService-resourceFields-name:
+externalService-resourceFields-removed: The date of when the was removed
+externalService-resourceFields-startOnCreate:
+externalService-resourceFields-state: The current state of the . The options are .
+externalService-resourceFields-transitioning: Whether or not the is in a transitioning state
+externalService-resourceFields-transitioningMessage: The message to show while in a transitioning state
+externalService-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+externalService-resourceFields-upgrade:
+externalService-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+externalServiceEvent-description:
+externalServiceEvent-resourceFields-accountId: The unique identifier for the associated account
+externalServiceEvent-resourceFields-created: The date of when the was created.
+externalServiceEvent-resourceFields-environment:
+externalServiceEvent-resourceFields-eventType:
+externalServiceEvent-resourceFields-externalId:
+externalServiceEvent-resourceFields-id: The unique identifier for the
+externalServiceEvent-resourceFields-kind:
+externalServiceEvent-resourceFields-reportedAccountId:
+externalServiceEvent-resourceFields-service:
+externalServiceEvent-resourceFields-state: The current state of the . The options are .
+externalServiceEvent-resourceFields-transitioning: Whether or not the is in a transitioning state
+externalServiceEvent-resourceFields-transitioningMessage: The message to show while in a transitioning state
+externalServiceEvent-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+externalServiceEvent-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+externalStoragePoolEvent-description:
+externalStoragePoolEvent-resourceFields-accountId: The unique identifier for the associated account
+externalStoragePoolEvent-resourceFields-created: The date of when the was created.
+externalStoragePoolEvent-resourceFields-eventType:
+externalStoragePoolEvent-resourceFields-externalId:
+externalStoragePoolEvent-resourceFields-hostUuids:
+externalStoragePoolEvent-resourceFields-id: The unique identifier for the
+externalStoragePoolEvent-resourceFields-kind:
+externalStoragePoolEvent-resourceFields-reportedAccountId:
+externalStoragePoolEvent-resourceFields-state: The current state of the . The options are .
+externalStoragePoolEvent-resourceFields-storagePool:
+externalStoragePoolEvent-resourceFields-transitioning: Whether or not the is in a transitioning state
+externalStoragePoolEvent-resourceFields-transitioningMessage: The message to show while in a transitioning state
+externalStoragePoolEvent-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+externalStoragePoolEvent-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+externalVolumeEvent-description:
+externalVolumeEvent-resourceFields-accountId: The unique identifier for the associated account
+externalVolumeEvent-resourceFields-created: The date of when the was created.
+externalVolumeEvent-resourceFields-eventType:
+externalVolumeEvent-resourceFields-externalId:
+externalVolumeEvent-resourceFields-id: The unique identifier for the
+externalVolumeEvent-resourceFields-kind:
+externalVolumeEvent-resourceFields-reportedAccountId:
+externalVolumeEvent-resourceFields-state: The current state of the . The options are .
+externalVolumeEvent-resourceFields-transitioning: Whether or not the is in a transitioning state
+externalVolumeEvent-resourceFields-transitioningMessage: The message to show while in a transitioning state
+externalVolumeEvent-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+externalVolumeEvent-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+externalVolumeEvent-resourceFields-volume:
+fieldDocumentation-description:
+fieldDocumentation-resourceFields-description:
+haproxyConfig-description:
+haproxyConfig-resourceFields-defaults:
+haproxyConfig-resourceFields-global:
+healthcheckInstanceHostMap-description:
+healthcheckInstanceHostMap-resourceFields-accountId: The unique identifier for the associated account
+healthcheckInstanceHostMap-resourceFields-created: The date of when the was created.
+healthcheckInstanceHostMap-resourceFields-description:
+healthcheckInstanceHostMap-resourceFields-healthState:
+healthcheckInstanceHostMap-resourceFields-hostId: The unique identifier for the associated host
+healthcheckInstanceHostMap-resourceFields-id: The unique identifier for the
+healthcheckInstanceHostMap-resourceFields-instanceId: The unique identifier for the associated instance
+healthcheckInstanceHostMap-resourceFields-kind:
+healthcheckInstanceHostMap-resourceFields-name:
+healthcheckInstanceHostMap-resourceFields-removed: The date of when the was removed
+healthcheckInstanceHostMap-resourceFields-state: The current state of the . The options are .
+healthcheckInstanceHostMap-resourceFields-transitioning: Whether or not the is in a transitioning state
+healthcheckInstanceHostMap-resourceFields-transitioningMessage: The message to show while in a transitioning state
+healthcheckInstanceHostMap-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+healthcheckInstanceHostMap-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+host-description: Hosts are the most basic unit of resource within Rancher and is represented as any Linux server, virtual or physical, with the following minimum requirements. was created.
+host-resourceFields-description:
+host-resourceFields-hostname:
+host-resourceFields-id: The unique identifier for the
+host-resourceFields-info:
+host-resourceFields-kind:
+host-resourceFields-labels: A map of key value pairs to be used as labels for the
+host-resourceFields-name:
+host-resourceFields-physicalHostId:
+host-resourceFields-publicEndpoints:
+host-resourceFields-removed: The date of when the was removed
+host-resourceFields-state: The current state of the . The options are .
+host-resourceFields-transitioning: Whether or not the is in a transitioning state
+host-resourceFields-transitioningMessage: The message to show while in a transitioning state
+host-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+host-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+hostAccess-description:
+hostAccess-resourceFields-token:
+hostAccess-resourceFields-url:
+identity-description: An identity is Rancher's representation of an object(i.e. `ldap_group`, `github_user`) when Rancher has turned on [access control]({{site.baseurl}}/rancher/{{page.version}}/{{page.lang}}/configuration/access-control/). The `externalId` in an identity is the unique identifier in the authentication system that represents the object. The role of an identity is always null unless it is being returned as the identity of a [projectMember]({{site.baseurl}}/rancher/{{page.version}}/{{page.lang}}/api/api-resources/projectMember/).
+identity-resourceFields-all:
+identity-resourceFields-externalId:
+identity-resourceFields-externalIdType:
+identity-resourceFields-id: The unique identifier for the
+identity-resourceFields-login:
+identity-resourceFields-name:
+identity-resourceFields-profilePicture:
+identity-resourceFields-profileUrl:
+identity-resourceFields-projectId:
+identity-resourceFields-role:
+image-description:
+image-resourceActions-activate:
+image-resourceActions-deactivate:
+image-resourceFields-accountId: The unique identifier for the associated account
+image-resourceFields-created: The date of when the was created.
+image-resourceFields-description:
+image-resourceFields-id: The unique identifier for the
+image-resourceFields-kind:
+image-resourceFields-name:
+image-resourceFields-removed: The date of when the was removed
+image-resourceFields-state: The current state of the . The options are .
+image-resourceFields-transitioning: Whether or not the is in a transitioning state
+image-resourceFields-transitioningMessage: The message to show while in a transitioning state
+image-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+image-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+inServiceUpgradeStrategy-description:
+inServiceUpgradeStrategy-resourceFields-batchSize:
+inServiceUpgradeStrategy-resourceFields-intervalMillis:
+inServiceUpgradeStrategy-resourceFields-launchConfig:
+inServiceUpgradeStrategy-resourceFields-previousLaunchConfig:
+inServiceUpgradeStrategy-resourceFields-previousSecondaryLaunchConfigs:
+inServiceUpgradeStrategy-resourceFields-secondaryLaunchConfigs:
+inServiceUpgradeStrategy-resourceFields-startFirst:
+instance-description:
+instance-resourceActions-console:
+instance-resourceActions-restart:
+instance-resourceActions-start:
+instance-resourceActions-stop:
+instance-resourceFields-accountId: The unique identifier for the associated account
+instance-resourceFields-created: The date of when the was created.
+instance-resourceFields-description:
+instance-resourceFields-externalId:
+instance-resourceFields-hostId: The unique identifier for the associated host
+instance-resourceFields-id: The unique identifier for the
+instance-resourceFields-kind:
+instance-resourceFields-name:
+instance-resourceFields-removed: The date of when the was removed
+instance-resourceFields-state: The current state of the . The options are .
+instance-resourceFields-transitioning: Whether or not the is in a transitioning state
+instance-resourceFields-transitioningMessage: The message to show while in a transitioning state
+instance-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+instance-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+instanceConsole-description:
+instanceConsole-resourceFields-kind:
+instanceConsole-resourceFields-password:
+instanceConsole-resourceFields-url:
+instanceConsoleInput-description:
+instanceHealthCheck-description:
+instanceHealthCheck-resourceFields-healthyThreshold:
+instanceHealthCheck-resourceFields-initializingTimeout:
+instanceHealthCheck-resourceFields-interval:
+instanceHealthCheck-resourceFields-name:
+instanceHealthCheck-resourceFields-port:
+instanceHealthCheck-resourceFields-recreateOnQuorumStrategyConfig:
+instanceHealthCheck-resourceFields-reinitializingTimeout:
+instanceHealthCheck-resourceFields-requestLine:
+instanceHealthCheck-resourceFields-responseTimeout:
+instanceHealthCheck-resourceFields-strategy:
+instanceHealthCheck-resourceFields-unhealthyThreshold:
+instanceLink-description:
+instanceLink-resourceActions-activate:
+instanceLink-resourceActions-deactivate:
+instanceLink-resourceFields-accountId: The unique identifier for the associated account
+instanceLink-resourceFields-created: The date of when the was created.
+instanceLink-resourceFields-description:
+instanceLink-resourceFields-id: The unique identifier for the
+instanceLink-resourceFields-instanceId: The unique identifier for the associated instance
+instanceLink-resourceFields-kind:
+instanceLink-resourceFields-linkName:
+instanceLink-resourceFields-name:
+instanceLink-resourceFields-removed: The date of when the was removed
+instanceLink-resourceFields-state: The current state of the . The options are .
+instanceLink-resourceFields-targetInstanceId:
+instanceLink-resourceFields-transitioning: Whether or not the is in a transitioning state
+instanceLink-resourceFields-transitioningMessage: The message to show while in a transitioning state
+instanceLink-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+instanceLink-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+instanceStop-description:
+instanceStop-resourceFields-remove:
+instanceStop-resourceFields-timeout:
+ipAddress-description:
+ipAddress-resourceFields-accountId: The unique identifier for the associated account
+ipAddress-resourceFields-address:
+ipAddress-resourceFields-created: The date of when the was created.
+ipAddress-resourceFields-description:
+ipAddress-resourceFields-id: The unique identifier for the
+ipAddress-resourceFields-kind:
+ipAddress-resourceFields-name:
+ipAddress-resourceFields-networkId:
+ipAddress-resourceFields-removed: The date of when the was removed
+ipAddress-resourceFields-state: The current state of the . The options are .
+ipAddress-resourceFields-transitioning: Whether or not the is in a transitioning state
+ipAddress-resourceFields-transitioningMessage: The message to show while in a transitioning state
+ipAddress-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+ipAddress-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+ipAddressAssociateInput-description:
+ipAddressAssociateInput-resourceFields-ipAddressId:
+kubernetesService-description:
+kubernetesService-resourceActions-activate:
+kubernetesService-resourceActions-addservicelink:
+kubernetesService-resourceActions-cancelrollback:
+kubernetesService-resourceActions-cancelupgrade:
+kubernetesService-resourceActions-deactivate:
+kubernetesService-resourceActions-finishupgrade:
+kubernetesService-resourceActions-removeservicelink:
+kubernetesService-resourceActions-restart:
+kubernetesService-resourceActions-rollback:
+kubernetesService-resourceActions-setservicelinks:
+kubernetesService-resourceActions-upgrade:
+kubernetesService-resourceFields-accountId: The unique identifier for the associated account
+kubernetesService-resourceFields-created: The date of when the was created.
+kubernetesService-resourceFields-description:
+kubernetesService-resourceFields-environmentId:
+kubernetesService-resourceFields-externalId:
+kubernetesService-resourceFields-healthState:
+kubernetesService-resourceFields-id: The unique identifier for the
+kubernetesService-resourceFields-kind:
+kubernetesService-resourceFields-name:
+kubernetesService-resourceFields-removed: The date of when the was removed
+kubernetesService-resourceFields-selectorContainer:
+kubernetesService-resourceFields-state: The current state of the . The options are .
+kubernetesService-resourceFields-template:
+kubernetesService-resourceFields-transitioning: Whether or not the is in a transitioning state
+kubernetesService-resourceFields-transitioningMessage: The message to show while in a transitioning state
+kubernetesService-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+kubernetesService-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+kubernetesService-resourceFields-vip:
+kubernetesStack-description:
+kubernetesStack-resourceActions-cancelrollback:
+kubernetesStack-resourceActions-cancelupgrade:
+kubernetesStack-resourceActions-error:
+kubernetesStack-resourceActions-finishupgrade:
+kubernetesStack-resourceActions-rollback:
+kubernetesStack-resourceActions-upgrade:
+kubernetesStack-resourceFields-accountId: The unique identifier for the associated account
+kubernetesStack-resourceFields-created: The date of when the was created.
+kubernetesStack-resourceFields-description:
+kubernetesStack-resourceFields-environment:
+kubernetesStack-resourceFields-externalId:
+kubernetesStack-resourceFields-healthState:
+kubernetesStack-resourceFields-id: The unique identifier for the
+kubernetesStack-resourceFields-kind:
+kubernetesStack-resourceFields-name:
+kubernetesStack-resourceFields-namespace:
+kubernetesStack-resourceFields-previousEnvironment:
+kubernetesStack-resourceFields-previousExternalId:
+kubernetesStack-resourceFields-removed: The date of when the was removed
+kubernetesStack-resourceFields-state: The current state of the . The options are .
+kubernetesStack-resourceFields-templates:
+kubernetesStack-resourceFields-transitioning: Whether or not the is in a transitioning state
+kubernetesStack-resourceFields-transitioningMessage: The message to show while in a transitioning state
+kubernetesStack-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+kubernetesStack-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+kubernetesStackUpgrade-description:
+kubernetesStackUpgrade-resourceFields-environment:
+kubernetesStackUpgrade-resourceFields-externalId:
+kubernetesStackUpgrade-resourceFields-templates:
+label-description:
+label-resourceFields-accountId: The unique identifier for the associated account
+label-resourceFields-created: The date of when the was created.
+label-resourceFields-description:
+label-resourceFields-id: The unique identifier for the
+label-resourceFields-key:
+label-resourceFields-kind:
+label-resourceFields-name:
+label-resourceFields-removed: The date of when the was removed
+label-resourceFields-state: The current state of the . The options are .
+label-resourceFields-transitioning: Whether or not the is in a transitioning state
+label-resourceFields-transitioningMessage: The message to show while in a transitioning state
+label-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+label-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+label-resourceFields-value:
+launchConfig-description:
+launchConfig-resourceFields-accountId: The unique identifier for the associated account
+launchConfig-resourceFields-blkioDeviceOptions:
+launchConfig-resourceFields-build:
+launchConfig-resourceFields-capAdd:
+launchConfig-resourceFields-capDrop:
+launchConfig-resourceFields-command: Overwrite the default commands set by the image
+launchConfig-resourceFields-count:
+launchConfig-resourceFields-cpuSet:
+launchConfig-resourceFields-cpuShares:
+launchConfig-resourceFields-createIndex:
+launchConfig-resourceFields-created: The date of when the was created.
+launchConfig-resourceFields-dataVolumeMounts:
+launchConfig-resourceFields-dataVolumes:
+launchConfig-resourceFields-dataVolumesFrom:
+launchConfig-resourceFields-dataVolumesFromLaunchConfigs:
+launchConfig-resourceFields-deploymentUnitUuid:
+launchConfig-resourceFields-description:
+launchConfig-resourceFields-devices:
+launchConfig-resourceFields-disks:
+launchConfig-resourceFields-dns:
+launchConfig-resourceFields-dnsSearch:
+launchConfig-resourceFields-domainName:
+launchConfig-resourceFields-entryPoint:
+launchConfig-resourceFields-environment:
+launchConfig-resourceFields-expose:
+launchConfig-resourceFields-externalId:
+launchConfig-resourceFields-extraHosts:
+launchConfig-resourceFields-firstRunning:
+launchConfig-resourceFields-healthCheck:
+launchConfig-resourceFields-healthState:
+launchConfig-resourceFields-hostId: The unique identifier for the associated host
+launchConfig-resourceFields-hostname:
+launchConfig-resourceFields-id: The unique identifier for the
+launchConfig-resourceFields-imageUuid:
+launchConfig-resourceFields-instanceLinks:
+launchConfig-resourceFields-kind:
+launchConfig-resourceFields-labels: A map of key value pairs to be used as labels for the
+launchConfig-resourceFields-logConfig:
+launchConfig-resourceFields-lxcConf:
+launchConfig-resourceFields-memory:
+launchConfig-resourceFields-memoryMb:
+launchConfig-resourceFields-memorySwap:
+launchConfig-resourceFields-nativeContainer:
+launchConfig-resourceFields-networkContainerId:
+launchConfig-resourceFields-networkIds:
+launchConfig-resourceFields-networkLaunchConfig:
+launchConfig-resourceFields-networkMode:
+launchConfig-resourceFields-pidMode:
+launchConfig-resourceFields-ports:
+launchConfig-resourceFields-primaryIpAddress:
+launchConfig-resourceFields-privileged:
+launchConfig-resourceFields-publishAllPorts:
+launchConfig-resourceFields-readOnly:
+launchConfig-resourceFields-registryCredentialId:
+launchConfig-resourceFields-removed: The date of when the was removed
+launchConfig-resourceFields-requestedHostId:
+launchConfig-resourceFields-requestedIpAddress:
+launchConfig-resourceFields-securityOpt:
+launchConfig-resourceFields-startCount:
+launchConfig-resourceFields-startOnCreate:
+launchConfig-resourceFields-state: The current state of the . The options are .
+launchConfig-resourceFields-stdinOpen:
+launchConfig-resourceFields-systemContainer:
+launchConfig-resourceFields-transitioning: Whether or not the is in a transitioning state
+launchConfig-resourceFields-transitioningMessage: The message to show while in a transitioning state
+launchConfig-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+launchConfig-resourceFields-tty:
+launchConfig-resourceFields-user:
+launchConfig-resourceFields-userdata:
+launchConfig-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+launchConfig-resourceFields-vcpu:
+launchConfig-resourceFields-version:
+launchConfig-resourceFields-volumeDriver:
+launchConfig-resourceFields-workingDir:
+loadBalancerAppCookieStickinessPolicy-description:
+loadBalancerAppCookieStickinessPolicy-resourceFields-cookie:
+loadBalancerAppCookieStickinessPolicy-resourceFields-maxLength:
+loadBalancerAppCookieStickinessPolicy-resourceFields-mode:
+loadBalancerAppCookieStickinessPolicy-resourceFields-name:
+loadBalancerAppCookieStickinessPolicy-resourceFields-prefix:
+loadBalancerAppCookieStickinessPolicy-resourceFields-requestLearn:
+loadBalancerAppCookieStickinessPolicy-resourceFields-timeout:
+loadBalancerConfig-description:
+loadBalancerConfig-resourceFields-haproxyConfig:
+loadBalancerConfig-resourceFields-lbCookieStickinessPolicy:
+loadBalancerCookieStickinessPolicy-description:
+loadBalancerCookieStickinessPolicy-resourceFields-cookie:
+loadBalancerCookieStickinessPolicy-resourceFields-domain:
+loadBalancerCookieStickinessPolicy-resourceFields-indirect:
+loadBalancerCookieStickinessPolicy-resourceFields-mode:
+loadBalancerCookieStickinessPolicy-resourceFields-name:
+loadBalancerCookieStickinessPolicy-resourceFields-nocache:
+loadBalancerCookieStickinessPolicy-resourceFields-postonly:
+loadBalancerService-description: Rancher implements a managed load balancer using HAProxy that can be manually scaled to multiple hosts. A load balancer can be used to distribute network and application traffic to individual containers by directly adding them or "linked" to a basic service. A basic service that is "linked" will have all its underlying containers automatically registered as load balancer targets by Rancher.
+loadBalancerService-resourceActions-activate:
+loadBalancerService-resourceActions-addservicelink:
+loadBalancerService-resourceActions-cancelrollback:
+loadBalancerService-resourceActions-cancelupgrade:
+loadBalancerService-resourceActions-deactivate:
+loadBalancerService-resourceActions-finishupgrade:
+loadBalancerService-resourceActions-removeservicelink:
+loadBalancerService-resourceActions-rollback:
+loadBalancerService-resourceActions-setservicelinks:
+loadBalancerService-resourceActions-upgrade:
+loadBalancerService-resourceFields-accountId: The unique identifier for the associated account
+loadBalancerService-resourceFields-assignServiceIpAddress:
+loadBalancerService-resourceFields-certificateIds:
+loadBalancerService-resourceFields-created: The date of when the was created.
+loadBalancerService-resourceFields-currentScale:
+loadBalancerService-resourceFields-defaultCertificateId:
+loadBalancerService-resourceFields-description:
+loadBalancerService-resourceFields-environmentId:
+loadBalancerService-resourceFields-externalId:
+loadBalancerService-resourceFields-fqdn:
+loadBalancerService-resourceFields-healthState:
+loadBalancerService-resourceFields-id: The unique identifier for the
+loadBalancerService-resourceFields-kind:
+loadBalancerService-resourceFields-launchConfig:
+loadBalancerService-resourceFields-loadBalancerConfig:
+loadBalancerService-resourceFields-metadata:
+loadBalancerService-resourceFields-name:
+loadBalancerService-resourceFields-publicEndpoints:
+loadBalancerService-resourceFields-removed: The date of when the was removed
+loadBalancerService-resourceFields-retainIp:
+loadBalancerService-resourceFields-scale:
+loadBalancerService-resourceFields-scalePolicy:
+loadBalancerService-resourceFields-selectorLink:
+loadBalancerService-resourceFields-startOnCreate:
+loadBalancerService-resourceFields-state: The current state of the . The options are .
+loadBalancerService-resourceFields-transitioning: Whether or not the is in a transitioning state
+loadBalancerService-resourceFields-transitioningMessage: The message to show while in a transitioning state
+loadBalancerService-resourceFields-transitioningProgress: The percentage remaining in the transitioning process of the
+loadBalancerService-resourceFields-upgrade:
+loadBalancerService-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+loadBalancerService-resourceFields-vip:
+loadBalancerServiceLink-description:
+loadBalancerServiceLink-resourceFields-ports:
+loadBalancerServiceLink-resourceFields-serviceId: The unique identifier of the associated service
+loadBalancerServiceLink-resourceFields-uuid: The universally unique identifier for the . This will always be unique across Rancher installations.
+logConfig-description:
+logConfig-resourceFields-config:
+logConfig-resourceFields-driver: The logging driver option to use in a logConfig.
+machine-description: Machines are created whenever Rancher uses `docker-machine` to create hosts in Rancher. Adding any type of host through the UI that is not the custom command option is calling `docker-machine` and a machine entry will be created as well as a [host]({{site.baseurl}}/rancher/{{page.version}}/{{page.lang}}/api/api-resources/host).
+machine-resourceFields-accountId: The unique identifier for the associated account
+machine-resourceFields-amazonec2Config:
+machine-resourceFields-authCertificateAuthority:
+machine-resourceFields-authKey:
+machine-resourceFields-azureConfig:
+machine-resourceFields-created: The date of when the was created.
+machine-resourceFields-description:
+machine-resourceFields-digitaloceanConfig:
+machine-resourceFields-dockerVersion:
+machine-resourceFields-driver:
+machine-resourceFields-engineEnv:
+machine-resourceFields-engineInsecureRegistry:
+machine-resourceFields-engineInstallUrl:
+machine-resourceFields-engineLabel:
+machine-resourceFields-engineOpt:
+machine-resourceFields-engineRegistryMirror:
+machine-resourceFields-engineStorageDriver:
+machine-resourceFields-externalId:
+machine-resourceFields-id: The unique identifier for the
+machine-resourceFields-kind:
+machine-resourceFields-labels: A map of key value pairs to be used as labels for the
+machine-resourceFields-name:
+machine-resourceFields-packetConfig:
+machine-resourceFields-removed: The date of when the was removed
+machine-resourceFields-state: The current state of the