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 ¶
Constants ¶
const ( // NamespaceAll represents all namespaces. NamespaceAll = "*" // IngressAPISIXLeader is the default election id for the controller // leader election. IngressAPISIXLeader = "ingress-apisix-leader" // IngressClass is the default ingress class name, used for Ingress // object's IngressClassName field in Kubernetes clusters version v1.18.0 // or higher, or the annotation "kubernetes.io/ingress.class" (deprecated). IngressClass = "apisix" // IngressNetworkingV1 represents ingress.networking/v1 IngressNetworkingV1 = "networking/v1" // IngressNetworkingV1beta1 represents ingress.networking/v1beta1 IngressNetworkingV1beta1 = "networking/v1beta1" // ApisixRouteV1 represents apisixroute.apisix.apache.org/v1 ApisixRouteV1 = "apisix.apache.org/v1" // ApisixRouteV2alpha1 represents apisixroute.apisix.apache.org/v2alpha1 ApisixRouteV2alpha1 = "apisix.apache.org/v2alpha1" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APISIXConfig ¶
type APISIXConfig struct {
BaseURL string `json:"base_url" yaml:"base_url"`
// TODO: Obsolete the plain way to specify admin_key, which is insecure.
AdminKey string `json:"admin_key" yaml:"admin_key"`
}
APISIXConfig contains all APISIX related config items.
type Config ¶
type Config struct {
LogLevel string `json:"log_level" yaml:"log_level"`
LogOutput string `json:"log_output" yaml:"log_output"`
HTTPListen string `json:"http_listen" yaml:"http_listen"`
EnableProfiling bool `json:"enable_profiling" yaml:"enable_profiling"`
Kubernetes KubernetesConfig `json:"kubernetes" yaml:"kubernetes"`
APISIX APISIXConfig `json:"apisix" yaml:"apisix"`
}
Config contains all config items which are necessary for apisix-ingress-controller's running.
func NewConfigFromFile ¶
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.
type KubernetesConfig ¶
type KubernetesConfig struct {
Kubeconfig string `json:"kubeconfig" yaml:"kubeconfig"`
ResyncInterval types.TimeDuration `json:"resync_interval" yaml:"resync_interval"`
AppNamespaces []string `json:"app_namespaces" yaml:"app_namespaces"`
ElectionID string `json:"election_id" yaml:"election_id"`
IngressClass string `json:"ingress_class" yaml:"ingress_class"`
IngressVersion string `json:"ingress_version" yaml:"ingress_version"`
ApisixRouteVersion string `json:"apisix_route_version" yaml:"apisix_route_version"`
}
KubernetesConfig contains all Kubernetes related config items.
Source Files