 Documentation
      ¶
      Documentation
      ¶
    
    
  
    
  
    Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewCmdRouter ¶
NewCmdRouter implements the OpenShift CLI router command.
Types ¶
type RouterConfig ¶
type RouterConfig struct {
	// Name is the router name, set as an argument
	Name string
	// Type is the router type, which determines which plugin to use (f5
	// or template).
	Type string
	// Subdomain is the subdomain served by this router. This may not be
	// accepted by all routers.
	Subdomain string
	// ForceSubdomain overrides the user's requested spec.host value on a
	// route and replaces it with this template. May not be used with Subdomain.
	ForceSubdomain string
	// ImageTemplate specifies the image from which the router will be created.
	ImageTemplate variable.ImageTemplate
	// Ports specifies the container ports for the router.
	Ports string
	// Replicas specifies the initial replica count for the router.
	Replicas int
	// Labels specifies the label or labels that will be assigned to the router
	// pod.
	Labels string
	// DryRun specifies that the router command should not launch a router but
	// should instead exit with code 1 to indicate if a router is already running
	// or code 0 otherwise.
	DryRun bool
	// SecretsAsEnv sets the credentials as env vars, instead of secrets.
	SecretsAsEnv bool
	// Credentials specifies the path to a .kubeconfig file with the credentials
	// with which the router may contact the master.
	Credentials string
	// DefaultCertificate holds the certificate that will be used if no more
	// specific certificate is found.  This is typically a wildcard certificate.
	DefaultCertificate string
	// Selector specifies a label or set of labels that determines the nodes on
	// which the router pod can be scheduled.
	Selector string
	// StatsPort specifies a port at which the router can provide statistics.
	StatsPort int
	// StatsPassword specifies a password required to authenticate connections to
	// the statistics port.
	StatsPassword string
	// StatsUsername specifies a username required to authenticate connections to
	// the statistics port.
	StatsUsername string
	// HostNetwork specifies whether to configure the router pod to use the host's
	// network namespace or the container's.
	HostNetwork bool
	// ServiceAccount specifies the service account under which the router will
	// run.
	ServiceAccount string
	// ExternalHost specifies the hostname or IP address of an external host for
	// router plugins that integrate with an external load balancer (such as f5).
	ExternalHost string
	// ExternalHostUsername specifies the username for authenticating with the
	// external host.
	ExternalHostUsername string
	// ExternalHostPassword specifies the password for authenticating with the
	// external host.
	ExternalHostPassword string
	// ExternalHostHttpVserver specifies the virtual server for HTTP connections.
	ExternalHostHttpVserver string
	// ExternalHostHttpsVserver specifies the virtual server for HTTPS connections.
	ExternalHostHttpsVserver string
	// ExternalHostPrivateKey specifies an SSH private key for authenticating with
	// the external host.
	ExternalHostPrivateKey string
	// ExternalHostInsecure specifies that the router should skip strict
	// certificate verification when connecting to the external host.
	ExternalHostInsecure bool
	// ExternalHostPartitionPath specifies the partition path to use.
	// This is used by some routers to create access access control
	// boundaries for users and applications.
	ExternalHostPartitionPath string
	// ExposeMetrics is a hint on whether to expose metrics.
	ExposeMetrics bool
	// MetricsImage is the image to run a sidecar container with in the router
	// pod.
	MetricsImage string
}
    RouterConfig contains the configuration parameters necessary to launch a router, including general parameters, type of router, and type-specific parameters.
       Source Files
      ¶
      Source Files
      ¶
    
- router.go
 Click to show internal directories. 
   Click to hide internal directories.