annotations

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
• type Extractor
  • func NewExtractor(annotations map[string]string) Extractor
• type IngressAnnotationsParser

Constants

const (
	// AnnotationsPrefix is the apisix annotation prefix
	AnnotationsPrefix = "k8s.apisix.apache.org/"

	// Supported annotations
	AnnotationsUseRegex         = AnnotationsPrefix + "use-regex"
	AnnotationsEnableWebSocket  = AnnotationsPrefix + "enable-websocket"
	AnnotationsPluginConfigName = AnnotationsPrefix + "plugin-config-name"
	AnnotationsUpstreamScheme   = AnnotationsPrefix + "upstream-scheme"

	//support retries and timeouts on upstream
	AnnotationsUpstreamRetry          = AnnotationsPrefix + "upstream-retries"
	AnnotationsUpstreamTimeoutConnect = AnnotationsPrefix + "upstream-connect-timeout"
	AnnotationsUpstreamTimeoutRead    = AnnotationsPrefix + "upstream-read-timeout"
	AnnotationsUpstreamTimeoutSend    = AnnotationsPrefix + "upstream-send-timeout"
)

const (

	// cors plugin
	AnnotationsEnableCors       = AnnotationsPrefix + "enable-cors"
	AnnotationsCorsAllowOrigin  = AnnotationsPrefix + "cors-allow-origin"
	AnnotationsCorsAllowHeaders = AnnotationsPrefix + "cors-allow-headers"
	AnnotationsCorsAllowMethods = AnnotationsPrefix + "cors-allow-methods"

	// csrf plugin
	AnnotationsEnableCsrf = AnnotationsPrefix + "enable-csrf"
	AnnotationsCsrfKey    = AnnotationsPrefix + "csrf-key"

	// redirect plugin
	AnnotationsHttpToHttps      = AnnotationsPrefix + "http-to-https"
	AnnotationsHttpRedirect     = AnnotationsPrefix + "http-redirect"
	AnnotationsHttpRedirectCode = AnnotationsPrefix + "http-redirect-code"

	// rewrite plugin
	AnnotationsRewriteTarget              = AnnotationsPrefix + "rewrite-target"
	AnnotationsRewriteTargetRegex         = AnnotationsPrefix + "rewrite-target-regex"
	AnnotationsRewriteTargetRegexTemplate = AnnotationsPrefix + "rewrite-target-regex-template"

	// response-rewrite plugin
	AnnotationsEnableResponseRewrite       = AnnotationsPrefix + "enable-response-rewrite"
	AnnotationsResponseRewriteStatusCode   = AnnotationsPrefix + "response-rewrite-status-code"
	AnnotationsResponseRewriteBody         = AnnotationsPrefix + "response-rewrite-body"
	AnnotationsResponseRewriteBodyBase64   = AnnotationsPrefix + "response-rewrite-body-base64"
	AnnotationsResponseRewriteHeaderAdd    = AnnotationsPrefix + "response-rewrite-add-header"
	AnnotationsResponseRewriteHeaderSet    = AnnotationsPrefix + "response-rewrite-set-header"
	AnnotationsResponseRewriteHeaderRemove = AnnotationsPrefix + "response-rewrite-remove-header"

	// forward-auth plugin
	AnnotationsForwardAuthURI             = AnnotationsPrefix + "auth-uri"
	AnnotationsForwardAuthSSLVerify       = AnnotationsPrefix + "auth-ssl-verify"
	AnnotationsForwardAuthRequestHeaders  = AnnotationsPrefix + "auth-request-headers"
	AnnotationsForwardAuthUpstreamHeaders = AnnotationsPrefix + "auth-upstream-headers"
	AnnotationsForwardAuthClientHeaders   = AnnotationsPrefix + "auth-client-headers"

	// ip-restriction plugin
	AnnotationsAllowlistSourceRange = AnnotationsPrefix + "allowlist-source-range"
	AnnotationsBlocklistSourceRange = AnnotationsPrefix + "blocklist-source-range"

	// http-method plugin
	AnnotationsHttpAllowMethods = AnnotationsPrefix + "http-allow-methods"
	AnnotationsHttpBlockMethods = AnnotationsPrefix + "http-block-methods"

	// key-auth plugin and basic-auth plugin
	// auth-type: keyAuth | basicAuth
	AnnotationsAuthType = AnnotationsPrefix + "auth-type"

	// support backend service cross namespace
	AnnotationsSvcNamespace = AnnotationsPrefix + "svc-namespace"
)

Types

type Extractor

type Extractor interface {
	// GetStringAnnotation returns the string value of the target annotation.
	// When the target annoatation is missing, empty string will be given.
	GetStringAnnotation(string) string
	// GetStringsAnnotation returns a string slice which splits the value of target
	// annotation by the comma symbol. When the target annotation is missing, a nil
	// slice will be given.
	GetStringsAnnotation(string) []string
	// GetBoolAnnotation returns a boolean value from the given annotation.
	// When value is "true", true will be given, other values will be treated as
	// false.
	GetBoolAnnotation(string) bool
}

Extractor encapsulates some auxiliary methods to extract annotations.

func NewExtractor

func NewExtractor(annotations map[string]string) Extractor

NewExtractor creates an annotation extractor.

type IngressAnnotationsParser

type IngressAnnotationsParser interface {
	// Handle parses the target annotation and converts it to the type-agnostic structure.
	// The return value might be nil since some features have an explicit switch, users should
	// judge whether Handle is failed by the second error value.
	Parse(Extractor) (interface{}, error)
}

Handler abstracts the behavior so that the apisix-ingress-controller knows