Documentation
¶
Overview ¶
Copyright (c) Alex Ellis 2017. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.
Index ¶
- Constants
- Variables
- func Execute(customArgs []string)
- func GetDefaultCLITransport(tlsInsecure bool, timeout *time.Duration) *http.Transport
- func GetDefaultSDKClient() (*sdk.Client, error)
- func JSONFormatMessage(msg logs.Message, timeFormat string, includeName, includeInstance bool) string
- func KeyValueFormatMessage(msg logs.Message, timeFormat string, includeName, includeInstance bool) string
- func PlainFormatMessage(msg logs.Message, timeFormat string, includeName, includeInstance bool) string
- type Auth
- type Cancel
- type DeployFlags
- type ECRRegistryAuth
- type LogFormatter
- type NamespaceCreateFlags
- type NamespaceUpdateFlags
- type RegistryAuth
- type TemplateInfo
Constants ¶
const DefaultTemplateRepository = "https://github.com/openfaas/templates.git"
DefaultTemplateRepository contains the Git repo for the official templates
const (
// DefaultTemplatesStore is the URL where the official store can be found
DefaultTemplatesStore = "https://raw.githubusercontent.com/openfaas/store/master/templates.json"
)
const (
// NoTLSWarn Warning thrown when no SSL/TLS is used
NoTLSWarn = "WARNING! You are not using an encrypted connection to the gateway, consider using HTTPS."
)
Variables ¶
var ( //Platform platform variable set at build time Platform string )
Functions ¶
func GetDefaultCLITransport ¶
func GetDefaultSDKClient ¶
func GetDefaultSDKClient() (*sdk.Client, error)
func JSONFormatMessage ¶
func JSONFormatMessage(msg logs.Message, timeFormat string, includeName, includeInstance bool) string
JSONFormatMessage is a JSON formatting for log messages, the options are ignored and the entire log message json serialized
Types ¶
type Cancel ¶
type Cancel struct {
// contains filtered or unexported fields
}
Cancel is a struct to hold a reference to a context and cancellation function between closures
type DeployFlags ¶
type DeployFlags struct {
// contains filtered or unexported fields
}
DeployFlags holds flags that are to be added to commands.
type ECRRegistryAuth ¶
type LogFormatter ¶
type LogFormatter func(msg logs.Message, timeFormat string, includeName, includeInstance bool) string
LogFormatter is a function that converts a log message to a string based on the supplied options
func GetLogFormatter ¶
func GetLogFormatter(name string) LogFormatter
GetLogFormatter maps a formatter name to a LogFormatter method
type NamespaceCreateFlags ¶
type NamespaceCreateFlags struct {
// contains filtered or unexported fields
}
NamespaceCreateFlags holds flags that are to be added to commands.
type NamespaceUpdateFlags ¶
type NamespaceUpdateFlags struct {
// contains filtered or unexported fields
}
NamespaceUpdateFlags holds flags that are to be added to commands.
type RegistryAuth ¶
type TemplateInfo ¶
type TemplateInfo struct {
TemplateName string `json:"template"`
Platform string `json:"platform"`
Language string `json:"language"`
Source string `json:"source"`
Description string `json:"description"`
Repository string `json:"repo"`
Official string `json:"official"`
Recommended bool `json:"recommended"`
}
TemplateInfo is the definition of a template which is part of the store
Source Files
¶
- bash_completion.go
- build.go
- completion.go
- deploy.go
- describe.go
- errors.go
- faas.go
- fetch_templates.go
- general.go
- generate.go
- invoke.go
- list.go
- local_run.go
- login.go
- logout.go
- logs.go
- logs_format.go
- namespace.go
- namespace_create.go
- namespace_delete.go
- namespace_get.go
- namespace_update.go
- namespaces_list.go
- new_function.go
- plugin.go
- plugin_get.go
- priority.go
- publish.go
- push.go
- ready.go
- registry_login.go
- remove.go
- secret.go
- secret_create.go
- secret_list.go
- secret_remove.go
- secret_update.go
- store.go
- store_deploy.go
- store_describe.go
- store_list.go
- template.go
- template_pull.go
- template_pull_stack.go
- template_store.go
- template_store_describe.go
- template_store_list.go
- template_store_pull.go
- up.go
- update_gitignore.go
- validate.go
- version.go
- watch.go