 Documentation
      ¶
      Documentation
      ¶
    
    
  
    
  
    Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Config ¶
type Config struct {
	// port to listen HTTP requests on
	Port int `yaml:"port" mapstructure:"port" default:"8080"`
	// GRPC Config
	GRPC GRPCConfig `mapstructure:"grpc"`
	// metrics port
	MetricsPort int `yaml:"metrics_port" mapstructure:"metrics_port" default:"9000"`
	// the network interface to listen on
	Host string `yaml:"host" mapstructure:"host" default:"127.0.0.1"`
	Name string
	// RulesPath is a directory path where ruleset is defined
	// that this service should implement
	RulesPath string `yaml:"ruleset" mapstructure:"ruleset"`
	// RulesPathSecret could be a env name, file path or actual value required
	// to access RulesPath files
	RulesPathSecret string `yaml:"ruleset_secret" mapstructure:"ruleset_secret"`
	// TODO might not suitable here because it is also being used by proxy
	// Headers which will have user's email id
	IdentityProxyHeader string `yaml:"identity_proxy_header" mapstructure:"identity_proxy_header" default:"X-Shield-Email"`
	// Header which will have user_id
	UserIDHeader string `yaml:"user_id_header" mapstructure:"user_id_header" default:"X-Shield-User-Id"`
	// ResourcesPath is a directory path where resources is defined
	// that this service should implement
	ResourcesConfigPath string `yaml:"resources_config_path" mapstructure:"resources_config_path"`
	// ResourcesPathSecretSecret could be a env name, file path or actual value required
	// to access ResourcesPathSecretPath files
	ResourcesConfigPathSecret string `yaml:"resources_config_path_secret" mapstructure:"resources_config_path_secret"`
	// CheckAPILimit will have the maximum number of resource permissions that can be included
	// in the resource permission check API. Default: 5
	CheckAPILimit int `yaml:"check_api_limit" mapstructure:"check_api_limit" default:"5"`
	DefaultSystemEmail string `yaml:"default_system_email" mapstructure:"default_system_email"  default:"shield-service@gotocompany.com"`
	ServiceData ServiceDataConfig `yaml:"service_data" mapstructure:"service_data"`
	PublicAPIPrefix string `yaml:"public_api_prefix" mapstructure:"public_api_prefix"  default:"/shield"`
	CacheConfig inmemory.Config `yaml:"cache" mapstructure:"cache"`
	InactiveEmailTag string `yaml:"inactive_email_tag" mapstructure:"inactive_email_tag" default:"inactive"`
}
    type GRPCConfig ¶
type ServiceDataConfig ¶ added in v0.6.22
type ServiceDataConfig struct {
	BootstrapEnabled          bool   `yaml:"bootstrap_enabled" mapstructure:"bootstrap_enabled" default:"true"`
	MaxNumUpsertData          int    `yaml:"max_num_upsert_data" mapstructure:"max_num_upsert_data" default:"1"`
	DefaultServiceDataProject string `yaml:"default_service_data_project" mapstructure:"default_service_data_project" default:"system"`
}
     Click to show internal directories. 
   Click to hide internal directories.