url

Documentation

Index

• Constants
• func Create(client *occlient.Client, kClient *kclient.Client, parameters CreateParameters, ...) (string, error)
• func Delete(client *occlient.Client, kClient *kclient.Client, urlName string, ...) error
• func Exists(client *occlient.Client, urlName string, componentName string, ...) (bool, error)
• func GetIngress(kClient *kclient.Client, envSpecificInfo *envinfo.EnvSpecificInfo, ...) (iextensionsv1.Ingress, error)
• func GetProtocol(route routev1.Route, ingress iextensionsv1.Ingress, isExperimental bool) string
• func GetURLName(componentName string, componentPort int) string
• func GetURLString(protocol, URL string, ingressDomain string, isExperimentalMode bool) string
• func GetValidExposedPortNumber(exposedPort int) (int, error)
• func GetValidPortNumber(componentName string, portNumber int, portList []string) (int, error)
• func ListPushedIngress(client *kclient.Client, componentName string) (iextensionsv1.IngressList, error)
• func Push(client *occlient.Client, kClient *kclient.Client, parameters PushParameters) error
• type CreateParameters
• type PushParameters
• type StateType
• type URL
  • func ConvertConfigURL(configURL config.ConfigURL) URL
  • func Get(client *occlient.Client, localConfig *config.LocalConfigInfo, urlName string, ...) (URL, error)
  • func GetContainerURL(client *lclient.Client, envSpecificInfo *envinfo.EnvSpecificInfo, ...) (URL, error)
• type URLList
  • func List(client *occlient.Client, localConfig *config.LocalConfigInfo, ...) (URLList, error)
  • func ListDockerURL(client *lclient.Client, componentName string, ...) (URLList, error)
  • func ListPushed(client *occlient.Client, componentName string, applicationName string) (URLList, error)
  • func (urls URLList) Get(urlName string) URL
• type URLSpec
• type URLStatus

Constants

const (
	// StateTypePushed means that URL is present both locally and on cluster/container
	StateTypePushed = "Pushed"
	// StateTypeNotPushed means that URL is only in local config, but not on the cluster/container
	StateTypeNotPushed = "Not Pushed"
	// StateTypeLocallyDeleted means that URL was deleted from the local config, but it is still present on the cluster/container
	StateTypeLocallyDeleted = "Locally Deleted"
)

Functions

func Create

func Create(client *occlient.Client, kClient *kclient.Client, parameters CreateParameters, isRouteSupported bool, isExperimental bool) (string, error)

Create creates a URL and returns url string and error if any portNumber is the target port number for the route and is -1 in case no port number is specified in which case it is automatically detected for components which expose only one service port)

func Delete

func Delete(client *occlient.Client, kClient *kclient.Client, urlName string, applicationName string, urlType envinfo.URLKind) error

Delete deletes a URL

func Exists

func Exists(client *occlient.Client, urlName string, componentName string, applicationName string) (bool, error)

Exists checks if the url exists in the component or not urlName is the name of the url for checking componentName is the name of the component to which the url's existence is checked applicationName is the name of the application to which the url's existence is checked

func GetIngress

func GetIngress(kClient *kclient.Client, envSpecificInfo *envinfo.EnvSpecificInfo, urlName string) (iextensionsv1.Ingress, error)

GetIngress returns ingress spec for given URL name

func GetProtocol

func GetProtocol(route routev1.Route, ingress iextensionsv1.Ingress, isExperimental bool) string

GetProtocol returns the protocol string

func GetURLName

func GetURLName(componentName string, componentPort int) string

GetURLName returns a url name from the component name and the given port number

func GetURLString

func GetURLString(protocol, URL string, ingressDomain string, isExperimentalMode bool) string

GetURLString returns a string representation of given url

func GetValidExposedPortNumber

func GetValidExposedPortNumber(exposedPort int) (int, error)

GetValidExposedPortNumber checks if the given exposed port number is a valid port or not if exposed port is not provided, a random free port will be generated and returned

func GetValidPortNumber

func GetValidPortNumber(componentName string, portNumber int, portList []string) (int, error)

GetValidPortNumber checks if the given port number is a valid component port or not if port number is not provided and the component is a single port component, the component port is returned port number is -1 if the user does not specify any port

func ListPushedIngress

func ListPushedIngress(client *kclient.Client, componentName string) (iextensionsv1.IngressList, error)

ListPushedIngress lists the ingress URLs for the given component

func Push

func Push(client *occlient.Client, kClient *kclient.Client, parameters PushParameters) error

Push creates and deletes the required URLs

Types

type CreateParameters

type CreateParameters struct {
	// contains filtered or unexported fields
}

type PushParameters

type PushParameters struct {
	ComponentName             string
	ApplicationName           string
	ConfigURLs                []config.ConfigURL
	EnvURLS                   []envinfo.EnvInfoURL
	IsRouteSupported          bool
	IsExperimentalModeEnabled bool
}

type StateType

type StateType string

type URL

type URL struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              URLSpec   `json:"spec,omitempty"`
	Status            URLStatus `json:"status,omitempty"`
}

URL is

func ConvertConfigURL

func ConvertConfigURL(configURL config.ConfigURL) URL

ConvertConfigURL converts ConfigURL to URL

func Get

func Get(client *occlient.Client, localConfig *config.LocalConfigInfo, urlName string, applicationName string) (URL, error)

Get returns URL definition for given URL name

func GetContainerURL

func GetContainerURL(client *lclient.Client, envSpecificInfo *envinfo.EnvSpecificInfo, urlName string, componentName string) (URL, error)

GetContainer returns Docker URL definition for given URL name

type URLList

type URLList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []URL `json:"items"`
}

AppList is a list of applications

func List

func List(client *occlient.Client, localConfig *config.LocalConfigInfo, componentName string, applicationName string) (URLList, error)

List returns all URLs for given component. If componentName is empty string, it lists all url in a given application.

func ListDockerURL

func ListDockerURL(client *lclient.Client, componentName string, envSpecificInfo *envinfo.EnvSpecificInfo) (URLList, error)

ListDockerURL returns all Docker URLs for given component.

func ListPushed

func ListPushed(client *occlient.Client, componentName string, applicationName string) (URLList, error)

ListPushed lists the URLs in an application that are in cluster. The results can further be narrowed down if a component name is provided, which will only list URLs for the given component

func (URLList) Get

func (urls URLList) Get(urlName string) URL

Get returns URL definition for given URL name

type URLSpec

type URLSpec struct {
	Host     string `json:"host,omitempty"`
	Protocol string `json:"protocol,omitempty"`
	Port     int    `json:"port,omitempty"`
	Secure   bool   `json:"secure"`

	ExternalPort int `json:"externalport,omitempty"`
	// contains filtered or unexported fields
}

URLSpec is

type URLStatus

type URLStatus struct {
	// "Pushed" or "Not Pushed" or "Locally Delted"
	State StateType `json:"state"`
}

URLStatus is Status of url