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.
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.
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.
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.
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.
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.
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.
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.
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.
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 ¶
- func NewParser() annotations.IngressAnnotationsParser
- type HttpMethod
- type PluginAnnotationsHandler
- func NewBasicAuthHandler() PluginAnnotationsHandler
- func NewCSRFHandler() PluginAnnotationsHandler
- func NewCorsHandler() PluginAnnotationsHandler
- func NewForwardAuthHandler() PluginAnnotationsHandler
- func NewHttpMethodHandler() PluginAnnotationsHandler
- func NewIPRestrictionHandler() PluginAnnotationsHandler
- func NewKeyAuthHandler() PluginAnnotationsHandler
- func NewRedirectHandler() PluginAnnotationsHandler
- func NewResponseRewriteHandler() PluginAnnotationsHandler
- func NewRewriteHandler() PluginAnnotationsHandler
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewParser ¶
func NewParser() annotations.IngressAnnotationsParser
Types ¶
type HttpMethod ¶
type HttpMethod struct{}
func (HttpMethod) Handle ¶
func (h HttpMethod) Handle(e annotations.Extractor) (interface{}, error)
func (HttpMethod) PluginName ¶
func (h HttpMethod) PluginName() string
type PluginAnnotationsHandler ¶
type PluginAnnotationsHandler 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. Handle(annotations.Extractor) (interface{}, error) // PluginName returns a string which indicates the target plugin name in APISIX. PluginName() string }
Handler abstracts the behavior so that the apisix-ingress-controller knows how to parse some annotations and convert them to APISIX plugins.
func NewBasicAuthHandler ¶
func NewBasicAuthHandler() PluginAnnotationsHandler
NewkeyBasicHandler creates a handler to convert annotations about basicAuth control to APISIX basic-auth plugin.
func NewCSRFHandler ¶
func NewCSRFHandler() PluginAnnotationsHandler
NewCSRFHandler creates a handler to convert annotations about CSRF to APISIX csrf plugin.
func NewCorsHandler ¶
func NewCorsHandler() PluginAnnotationsHandler
NewCorsHandler creates a handler to convert annotations about CORS to APISIX cors plugin.
func NewForwardAuthHandler ¶
func NewForwardAuthHandler() PluginAnnotationsHandler
NewForwardAuthHandler creates a handler to convert annotations about forward authentication to APISIX forward-auth plugin.
func NewHttpMethodHandler ¶
func NewHttpMethodHandler() PluginAnnotationsHandler
NewHttpHandler creates a handler to convert annotations about HttpMethod to APISIX cors plugin.
func NewIPRestrictionHandler ¶
func NewIPRestrictionHandler() PluginAnnotationsHandler
NewIPRestrictionHandler creates a handler to convert annotations about client ips control to APISIX ip-restrict plugin.
func NewKeyAuthHandler ¶
func NewKeyAuthHandler() PluginAnnotationsHandler
NewkeyAuthHandler creates a handler to convert annotations about keyAuth control to APISIX key-auth plugin.
func NewRedirectHandler ¶
func NewRedirectHandler() PluginAnnotationsHandler
NewRedirectHandler creates a handler to convert annotations about redirect control to APISIX redirect plugin.
func NewResponseRewriteHandler ¶
func NewResponseRewriteHandler() PluginAnnotationsHandler
NewResponseRewriteHandler creates a handler to convert annotations about ResponseRewrite to APISIX response-rewrite plugin.
func NewRewriteHandler ¶
func NewRewriteHandler() PluginAnnotationsHandler
NewRewriteHandler creates a handler to convert annotations about request rewrite control to APISIX proxy-rewrite plugin.