config

Documentation

Overview

Copyright (C) 2019-2024 vdaas.org vald team <vald@vdaas.org>

Licensed 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

https://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 Data
  • func NewConfig(path string) (cfg *Data, err error)
• type GlobalConfig
• type Server

Types

type Data

type Data struct {
	config.GlobalConfig `json:",inline" yaml:",inline"`

	// Server represent all server configurations
	Server *config.Servers `json:"server_config" yaml:"server_config"`

	// Observability represent observability configurations
	Observability *config.Observability `json:"observability" yaml:"observability"`

	// Mirror represent mirror gateway service configuration
	Mirror *config.Mirror `json:"gateway" yaml:"gateway"`
}

Data represent a application setting data content (config.yaml). In K8s environment, this configuration is stored in K8s ConfigMap.

func NewConfig

func NewConfig(path string) (cfg *Data, err error)

NewConfig load configurations from file path.

type GlobalConfig

type GlobalConfig = config.GlobalConfig

GlobalConfig is a type alias of config.GlobalConfig representing application base configurations.

type Server

type Server = config.Server

Server is a type alias of config.Server representing server base configurations.