apicast

package
v0.9.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 21, 2024 License: Apache-2.0 Imports: 21 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	AdminPortalURLAttributeName       = "AdminPortalURL"
	DefaultManagementPort       int32 = 8090
	DefaultMetricsPort          int32 = 9421
	DefaultTracingLibrary             = "jaeger"
	TracingConfigSecretKey            = "config"
)
View Source 
const (
	EmbeddedConfigurationMountPath  = "/tmp/gateway-configuration-volume"
	EmbeddedConfigurationVolumeName = "gateway-configuration-volume"
	EmbeddedConfigurationSecretKey  = "config.json"
)
View Source 
const (
	HTTPSCertificatesMountPath  = "/var/run/secrets/apicast"
	HTTPSCertificatesVolumeName = "https-certificates"
	CustomPoliciesMountBasePath = "/opt/app-root/src/policies"
	CustomEnvsMountBasePath     = "/opt/app-root/src/custom-environments"
	TracingConfigMountBasePath  = "/opt/app-root/src/tracing-configs"
)
View Source 
const (
	OpentelemetryConfigurationVolumeName = "otel-volume"
	OpentelemetryConfigMountBasePath     = "/opt/app-root/src/otel-configs"
)
View Source 
const (
	AdmPortalSecretResverAnnotation            = "apicast.apps.3scale.net/admin-portal-secret-resource-version"
	GatewayConfigurationSecretResverAnnotation = "apicast.apps.3scale.net/gateway-configuration-secret-resource-version"
	HttpsCertSecretResverAnnotation            = "apicast.apps.3scale.net/https-cert-secret-resource-version"
	OpenTracingSecretResverAnnotation          = "apicast.apps.3scale.net/opentracing-secret-resource-version"
	CustomEnvSecretResverAnnotationPrefix      = "apicast.apps.3scale.net/customenv-secret-resource-version-"
	CustomPoliciesSecretResverAnnotationPrefix = "apicast.apps.3scale.net/custompolicy-secret-resource-version-"
	APPLABEL                                   = "apicast"
)

Variables

This section is empty.

Functions

func APIcastDeploymentName added in v0.8.0 

func APIcastDeploymentName(cr *appsv1alpha1.APIcast) string

func DefaultResourceRequirements added in v0.4.0 

func DefaultResourceRequirements(hpa bool) v1.ResourceRequirements

func GetDefaultImageVersion 

func GetDefaultImageVersion() string

Types

type APIcast 

type APIcast struct {
	// contains filtered or unexported fields
}

func Factory added in v0.3.0 

func Factory(ctx context.Context, cr *appsv1alpha1.APIcast, cl client.Client) (*APIcast, error)

func NewAPIcast added in v0.3.0 

func NewAPIcast(opts *APIcastOptions) *APIcast

func (*APIcast) Deployment 

func (a *APIcast) Deployment() *appsv1.Deployment

func (*APIcast) Ingress 

func (a *APIcast) Ingress() *networkingv1.Ingress

func (*APIcast) Service 

func (a *APIcast) Service() *v1.Service

type APIcastOptions added in v0.3.0 

type APIcastOptions struct {
	Namespace                    string                 `validate:"required"`
	DeploymentName               string                 `validate:"required"`
	Owner                        *metav1.OwnerReference `validate:"required"`
	ServiceName                  string                 `validate:"required"`
	Replicas                     int32
	AdditionalPodAnnotations     map[string]string       `validate:"required"`
	ServiceAccountName           string                  `validate:"required"`
	Image                        string                  `validate:"required"`
	ExposedHost                  ExposedHost             `validate:"-"`
	AdminPortalCredentialsSecret *v1.Secret              `validate:"required_without=GatewayConfigurationSecret"`
	GatewayConfigurationSecret   *v1.Secret              `validate:"required_without=AdminPortalCredentialsSecret"`
	ResourceRequirements         v1.ResourceRequirements `validate:"-"`
	Hpa                          bool

	DeploymentEnvironment               *string
	DNSResolverAddress                  *string
	EnabledServices                     []string
	ConfigurationLoadMode               *string
	LogLevel                            *string
	PathRoutingEnabled                  *bool
	ResponseCodesIncluded               *bool
	CacheConfigurationSeconds           *int64
	ManagementAPIScope                  *string
	OpenSSLPeerVerificationEnabled      *bool
	UpstreamRetryCases                  *string
	ServiceCacheSize                    *int32
	CacheMaxTime                        *string
	CacheStatusCodes                    *string
	OidcLogLevel                        *string
	LoadServicesWhenNeeded              *bool
	ServicesFilterByURL                 *string
	ServiceConfigurationVersionOverride map[string]string
	HTTPSPort                           *int32
	HTTPSVerifyDepth                    *int64
	HTTPSCertificateSecret              *v1.Secret
	Workers                             *int32
	Timezone                            *string
	CustomPolicies                      []CustomPolicy
	ExtendedMetrics                     *bool
	CustomEnvironments                  []*v1.Secret
	TracingConfig                       TracingConfig `validate:"-"`
	AllProxy                            *string
	HTTPProxy                           *string
	HTTPSProxy                          *string
	NoProxy                             *string

	CommonLabels      map[string]string `validate:"required"`
	PodTemplateLabels map[string]string `validate:"required"`
	PodLabelSelector  map[string]string `validate:"required"`

	Opentelemetry OpentelemetryConfig `validate:"-"`
}

func NewAPIcastOptions added in v0.3.0 

func NewAPIcastOptions() *APIcastOptions

func (*APIcastOptions) Validate added in v0.3.0 

func (a *APIcastOptions) Validate() error

type APIcastOptionsProvider added in v0.3.0 

type APIcastOptionsProvider struct {
	APIcastCR      *appsv1alpha1.APIcast
	APIcastOptions *APIcastOptions
	Client         client.Client
}

func NewApicastOptionsProvider added in v0.3.0 

func NewApicastOptionsProvider(cr *appsv1alpha1.APIcast, cl client.Client) *APIcastOptionsProvider

func (*APIcastOptionsProvider) GetApicastOptions added in v0.3.0 

func (a *APIcastOptionsProvider) GetApicastOptions(ctx context.Context) (*APIcastOptions, error)

type CustomPolicy added in v0.5.1 

type CustomPolicy struct {
	Name    string
	Version string
	Secret  *v1.Secret
}

type ExposedHost 

type ExposedHost struct {
	Host string
	TLS  []networkingv1.IngressTLS
}

type OpentelemetryConfig added in v0.8.0 

type OpentelemetryConfig struct {
	Enabled    bool
	SecretName string
	ConfigFile string
}

type TracingConfig added in v0.5.1 

type TracingConfig struct {
	Enabled        bool
	TracingLibrary string `validate:"required"`
	Secret         *v1.Secret
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.