apicast

package

v0.7.1 Latest Latest Go to latest Published: Dec 22, 2022 License: Apache-2.0 Imports: 20 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/3scale/apicast-operator

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func DefaultResourceRequirements() v1.ResourceRequirements
func GetDefaultImageVersion() string
type APIcast
- func Factory(ctx context.Context, cr *appsv1alpha1.APIcast, cl client.Client) (*APIcast, error)
- func NewAPIcast(opts *APIcastOptions) *APIcast
type APIcastOptions
- func NewAPIcastOptions() *APIcastOptions
- func (a *APIcastOptions) Validate() error
type APIcastOptionsProvider
- func NewApicastOptionsProvider(cr *appsv1alpha1.APIcast, cl client.Client) *APIcastOptionsProvider
- func (a *APIcastOptionsProvider) GetApicastOptions(ctx context.Context) (*APIcastOptions, error)
type CustomPolicy
type ExposedHost
type TracingConfig

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 (
	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 DefaultResourceRequirements ¶ added in v0.4.0

func DefaultResourceRequirements() 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:"-"`

	DeploymentEnvironment               *string
	DNSResolverAddress                  *string
	EnabledServices                     []string
	ConfigurationLoadMode               *string
	LogLevel                            *string
	PathRoutingEnabled                  *bool
	ResponseCodesIncluded               *bool
	CacheConfigurationSeconds           *int64
	ManagementAPIScope                  *string
	OpenSSLPeerVerificationEnabled      *bool
	UpstreamRetryCases                  *string
	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"`
}

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 TracingConfig ¶ added in v0.5.1

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL