types

Documentation

Overview

MIT License

Copyright (c) 2022 Kubeshop

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

MIT License

Copyright (c) 2022 Kubeshop

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

MIT License

Copyright (c) 2022 Kubeshop

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

MIT License

Copyright (c) 2022 Kubeshop

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

MIT License

Copyright (c) 2022 Kubeshop

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

• func GenerateCORSPolicy(origins, methods, headers, exposeHeaders []string, maxAge int, ...) (*route.CorsPolicy, error)
• func GenerateRewriteRegex(pattern string, substitution string) *envoytypematcher.RegexMatchAndSubstitute
• func GenerateRouteName(path, method string) string
• func GetHeaderMatcherConfig(methods []string, cors bool) *route.HeaderMatcher
• type ParamSchema
• type RouteMatcherBuilder
  • func NewRouteMatcherBuilder(path string, pathParameters map[string]ParamSchema) *RouteMatcherBuilder
  • func (r RouteMatcherBuilder) GetRouteMatcher(headers []*route.HeaderMatcher) *route.RouteMatch
• type RouteRedirectBuilder
  • func NewRouteRedirectBuilder() *RouteRedirectBuilder
  • func (r *RouteRedirectBuilder) HostRedirect(host string) *RouteRedirectBuilder
  • func (r *RouteRedirectBuilder) PathRedirect(path string) *RouteRedirectBuilder
  • func (r *RouteRedirectBuilder) PortRedirect(port uint32) *RouteRedirectBuilder
  • func (r *RouteRedirectBuilder) RegexRedirect(pattern, substitution string) *RouteRedirectBuilder
  • func (r *RouteRedirectBuilder) ResponseCode(code uint32) *RouteRedirectBuilder
  • func (r *RouteRedirectBuilder) SchemeRedirect(scheme string) *RouteRedirectBuilder
  • func (r *RouteRedirectBuilder) StripQuery(stripQuery *bool) *RouteRedirectBuilder
  • func (r *RouteRedirectBuilder) ValidateAndReturn() (*route.Route_Redirect, error)
• type VirtualHost
  • func NewVirtualHost(name string) *VirtualHost
  • func (v *VirtualHost) AddDomain(domain string)
  • func (v *VirtualHost) AddRoute(r *route.Route) error

Functions

func GenerateCORSPolicy

func GenerateCORSPolicy(
	origins,
	methods,
	headers,
	exposeHeaders []string,
	maxAge int,
	credentials *bool,
) (*route.CorsPolicy, error)

func GenerateRewriteRegex

func GenerateRewriteRegex(pattern string, substitution string) *envoytypematcher.RegexMatchAndSubstitute

func GenerateRouteName

func GenerateRouteName(path, method string) string

func GetHeaderMatcherConfig

func GetHeaderMatcherConfig(methods []string, cors bool) *route.HeaderMatcher

Types

type ParamSchema

type ParamSchema struct {
	Type string
	Enum []interface{}
}

type RouteMatcherBuilder

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

func NewRouteMatcherBuilder

func NewRouteMatcherBuilder(path string, pathParameters map[string]ParamSchema) *RouteMatcherBuilder

func (RouteMatcherBuilder) GetRouteMatcher

func (r RouteMatcherBuilder) GetRouteMatcher(headers []*route.HeaderMatcher) *route.RouteMatch

type RouteRedirectBuilder

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

func NewRouteRedirectBuilder

func NewRouteRedirectBuilder() *RouteRedirectBuilder

func (*RouteRedirectBuilder) HostRedirect

func (r *RouteRedirectBuilder) HostRedirect(host string) *RouteRedirectBuilder

func (*RouteRedirectBuilder) PathRedirect

func (r *RouteRedirectBuilder) PathRedirect(path string) *RouteRedirectBuilder

func (*RouteRedirectBuilder) PortRedirect

func (r *RouteRedirectBuilder) PortRedirect(port uint32) *RouteRedirectBuilder

func (*RouteRedirectBuilder) RegexRedirect

func (r *RouteRedirectBuilder) RegexRedirect(pattern, substitution string) *RouteRedirectBuilder

func (*RouteRedirectBuilder) ResponseCode

func (r *RouteRedirectBuilder) ResponseCode(code uint32) *RouteRedirectBuilder

func (*RouteRedirectBuilder) SchemeRedirect

func (r *RouteRedirectBuilder) SchemeRedirect(scheme string) *RouteRedirectBuilder

func (*RouteRedirectBuilder) StripQuery

func (r *RouteRedirectBuilder) StripQuery(stripQuery *bool) *RouteRedirectBuilder

func (*RouteRedirectBuilder) ValidateAndReturn

func (r *RouteRedirectBuilder) ValidateAndReturn() (*route.Route_Redirect, error)

type VirtualHost

type VirtualHost struct {
	*route.VirtualHost
}

func NewVirtualHost

func NewVirtualHost(name string) *VirtualHost

func (*VirtualHost) AddDomain

func (v *VirtualHost) AddDomain(domain string)

func (*VirtualHost) AddRoute

func (v *VirtualHost) AddRoute(r *route.Route) error