config

Documentation

Overview

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You 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

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.

Index

• type APINTOConfig
• type Config
  • func NewConfigFromFile(filename string) (*Config, error)
  • func NewDefaultConfig() *Config
  • func (cfg *Config) Validate() error
• type KubernetesConfig
• type LogConfig

Types

type APINTOConfig

type APINTOConfig struct {
	DefaultClusterName string `json:"default_cluster_name"`
	// DefaultClusterBaseURL is the base url configuration for the default cluster.
	DefaultClusterBaseURL string `json:"default_cluster_base_url" yaml:"default_cluster_base_url"`
	// DefaultClusterAdminKey is the admin key for the default cluster.
	// TODO: Obsolete the plain way to specify admin_key, which is insecure.
	DefaultClusterAdminKey string `json:"default_cluster_admin_key" yaml:"default_cluster_admin_key"`
}

APINTOConfig contains all APINTO related config items.

type Config

type Config struct {
	CertFilePath    string       `json:"cert_file" yaml:"cert_file"`
	KeyFilePath     string       `json:"key_file" yaml:"key_file"`
	Log             LogConfig    `json:"log" yaml:"log"`
	HTTPListen      string       `json:"http_listen" yaml:"http_listen"`
	HTTPSListen     string       `json:"https_listen" yaml:"https_listen"`
	EnableProfiling bool         `json:"enable_profiling" yaml:"enable_profiling"`
	APINTO          APINTOConfig `json:"apinto" yaml:"apinto"`
}

Config contains all config items which are necessary for apinto-ingress-controller's running.

func NewConfigFromFile

func NewConfigFromFile(filename string) (*Config, error)

NewConfigFromFile creates a Config object and fills all config items according to the configuration file. The file can be in JSON/YAML format, which will be distinguished according to the file suffix.

func NewDefaultConfig

func NewDefaultConfig() *Config

NewDefaultConfig creates a Config object which fills all config items with default value.

func (*Config) Validate

func (cfg *Config) Validate() error

Validate validates whether the Config is right.

type KubernetesConfig

type KubernetesConfig struct {
	Kubeconfig        string   `json:"kubeconfig" yaml:"kubeconfig"`
	AppNamespaces     []string `json:"app_namespaces" yaml:"app_namespaces"`
	NamespaceSelector []string `json:"namespace_selector" yaml:"namespace_selector"`
	IngressClass      string   `json:"ingress_class" yaml:"ingress_class"`
	IngressVersion    string   `json:"ingress_version" yaml:"ingress_version"`
}

KubernetesConfig contains all Kubernetes related config items.

type LogConfig

type LogConfig struct {
	LogOutput string `json:"log_output" yaml:"log_output"`
	LogLevel  string `json:"log_level" yaml:"log_level"`
	LogPeriod string `json:"log_period" yaml:"log_period"`
	LogExpire string `json:"log_expire" yaml:"log_expire"`
}