Documentation
      ¶
    
    
  
    
  
    Overview ¶
Copyright 2023 Apoxy, Inc.
Licensed 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.
      
      Directories
      ¶
    
    | Path | Synopsis | 
|---|---|
| 
       api
        | 
      |
| 
         
          
            config/v1alpha1
            
            
          
           
      Package v1alpha1 contains API Schema definitions for the config v1alpha1 API group 
         | 
      Package v1alpha1 contains API Schema definitions for the config v1alpha1 API group | 
| 
         
          
            controllers/v1alpha1
            
            
          
           
      Package v1alpha1 contains API Schema definitions for the core v1alpha1 API group 
         | 
      Package v1alpha1 contains API Schema definitions for the core v1alpha1 API group | 
| 
         
          
            core/v1alpha
            
            
          
           
      Package v1alpha contains API Schema definitions for the core v1alpha API group 
         | 
      Package v1alpha contains API Schema definitions for the core v1alpha API group | 
| 
         
          
            extensions/v1alpha1
            
            
          
           
      Package v1alpha1 contains API Schema definitions for the exstensions v1alpha1 API group 
         | 
      Package v1alpha1 contains API Schema definitions for the exstensions v1alpha1 API group | 
| 
         
          
            extensions/v1alpha2
            
            
          
           
      Package v1alpha2 contains API Schema definitions for the exstensions v1alpha2 API group 
         | 
      Package v1alpha2 contains API Schema definitions for the exstensions v1alpha2 API group | 
| 
         
          
            gateway/v1
            
            
          
           
      Package v1 is the v1 version of the API. 
         | 
      Package v1 is the v1 version of the API. | 
| 
         
          
            policy/v1alpha1
            
            
          
           
      Package v1alpha1 contains API Schema definitions for the policy v1alpha1 API group. 
         | 
      Package v1alpha1 contains API Schema definitions for the policy v1alpha1 API group. | 
| 
       client
        | 
      |
| 
         
          
            versioned/fake
            
            
          
           
      This package has the automatically generated fake clientset. 
         | 
      This package has the automatically generated fake clientset. | 
| 
         
          
            versioned/scheme
            
            
          
           
      This package contains the scheme of the automatically generated clientset. 
         | 
      This package contains the scheme of the automatically generated clientset. | 
| 
         
          
            versioned/typed/controllers/v1alpha1
            
            
          
           
      This package has the automatically generated typed clients. 
         | 
      This package has the automatically generated typed clients. | 
| 
         
          
            versioned/typed/controllers/v1alpha1/fake
            
            
          
           
      Package fake has the automatically generated clients. 
         | 
      Package fake has the automatically generated clients. | 
| 
         
          
            versioned/typed/core/v1alpha
            
            
          
           
      This package has the automatically generated typed clients. 
         | 
      This package has the automatically generated typed clients. | 
| 
         
          
            versioned/typed/core/v1alpha/fake
            
            
          
           
      Package fake has the automatically generated clients. 
         | 
      Package fake has the automatically generated clients. | 
| 
         
          
            versioned/typed/extensions/v1alpha1
            
            
          
           
      This package has the automatically generated typed clients. 
         | 
      This package has the automatically generated typed clients. | 
| 
         
          
            versioned/typed/extensions/v1alpha1/fake
            
            
          
           
      Package fake has the automatically generated clients. 
         | 
      Package fake has the automatically generated clients. | 
| 
         
          
            versioned/typed/extensions/v1alpha2
            
            
          
           
      This package has the automatically generated typed clients. 
         | 
      This package has the automatically generated typed clients. | 
| 
         
          
            versioned/typed/extensions/v1alpha2/fake
            
            
          
           
      Package fake has the automatically generated clients. 
         | 
      Package fake has the automatically generated clients. | 
| 
         
          
            versioned/typed/gateway/v1
            
            
          
           
      This package has the automatically generated typed clients. 
         | 
      This package has the automatically generated typed clients. | 
| 
         
          
            versioned/typed/gateway/v1/fake
            
            
          
           
      Package fake has the automatically generated clients. 
         | 
      Package fake has the automatically generated clients. | 
| 
         
          
            versioned/typed/policy/v1alpha1
            
            
          
           
      This package has the automatically generated typed clients. 
         | 
      This package has the automatically generated typed clients. | 
| 
         
          
            versioned/typed/policy/v1alpha1/fake
            
            
          
           
      Package fake has the automatically generated clients. 
         | 
      Package fake has the automatically generated clients. | 
| 
       cmd
        | 
      |
| 
         
          
            apiserver
            
            command
          
          
         
       | 
      |
| 
         
          
            backplane
            
            command
          
          
         
       | 
      |
| 
         
          
            dial-stdio
            
            command
          
           
      dial-stdio provides a dialer that connects to the standard I/O streams. 
         | 
      dial-stdio provides a dialer that connects to the standard I/O streams. | 
| 
         
          
            tunnelproxy
            
            command
          
          
         
       | 
      |
| 
       pkg
        | 
      |
| 
         
          
            apiserver/auth
            
            
          
           
      Package auth contains APIServer authentication helpers. 
         | 
      Package auth contains APIServer authentication helpers. | 
| 
         
          
            apiserver/controllers
            
            
          
           
      Package controllers implements Apoxy Control Plane-side controllers. 
         | 
      Package controllers implements Apoxy Control Plane-side controllers. | 
| 
         
          
            apiserver/extensions
            
            
          
           
      Package extensions implements extensions controllers. 
         | 
      Package extensions implements extensions controllers. | 
| 
         
          
            apiserver/gateway
            
            
          
           
      Package gateway implements Gateway API controllers. 
         | 
      Package gateway implements Gateway API controllers. | 
| 
         
          
            apiserver/policy
            
            
          
           
      Package policy implements API Server policy controllers. 
         | 
      Package policy implements API Server policy controllers. | 
| 
         
          
            backplane/logs
            
            
          
           
      Package logs provides logging facilities for Envoy. 
         | 
      Package logs provides logging facilities for Envoy. | 
| 
         
          
            backplane/logs/logtail
            
            
          
           
      Package logtail consumes log files and manages compaction using fallocate. 
         | 
      Package logtail consumes log files and manages compaction using fallocate. | 
| 
         
          
            backplane/otel
            
            
          
           
      Package otel provides functionality for managing OpenTelemetry collector processes. 
         | 
      Package otel provides functionality for managing OpenTelemetry collector processes. | 
| 
         
          
            backplane/portforward
            
            
          
           
      Package portforward watches a port on a ProxyReplica and forwards from a local port to the remote port on the ProxyReplica. 
         | 
      Package portforward watches a port on a ProxyReplica and forwards from a local port to the remote port on the ProxyReplica. | 
| 
         
          
            backplane/wasm/manifest
            
            
          
           
      Package manifest implements Edge Function Manifest utilities. 
         | 
      Package manifest implements Edge Function Manifest utilities. | 
| 
         
          
            clickhouse/migrations
            
            
          
           
      Package migrations provides database migrations for ClickHouse. 
         | 
      Package migrations provides database migrations for ClickHouse. | 
| 
         
          
            drivers
            
            
          
           
      Package drivers implements common interfaces and utilities for Apoxy service drivers 
         | 
      Package drivers implements common interfaces and utilities for Apoxy service drivers | 
| 
         
          
            edgefunc/runc
            
            
          
           
      Package runc implements container runtime based on OpenContainers libcontainer package. 
         | 
      Package runc implements container runtime based on OpenContainers libcontainer package. | 
| 
         
          
            edgefunc/runc/network/iptables
            
            
          
           
      Package iptables container useful routines for manipulating iptables rules. 
         | 
      Package iptables container useful routines for manipulating iptables rules. | 
| 
         
          
            gateway/xds/cache
            
            
          
           
      This file contains code derived from Contour, https://github.com/projectcontour/contour from the source file https://github.com/projectcontour/contour/blob/main/internal/xds/v3/snapshotter.go and is provided here subject to the following: Copyright Project Contour Authors SPDX-License-Identifier: Apache-2.0 
         | 
      This file contains code derived from Contour, https://github.com/projectcontour/contour from the source file https://github.com/projectcontour/contour/blob/main/internal/xds/v3/snapshotter.go and is provided here subject to the following: Copyright Project Contour Authors SPDX-License-Identifier: Apache-2.0 | 
| 
         
          
            gateway/xds/extensions
            
            
          
           
      Import all Envoy filter types so they are registered and deserialization does not fail when using them in the "typed_config" attributes. 
         | 
      Import all Envoy filter types so they are registered and deserialization does not fail when using them in the "typed_config" attributes. | 
| 
         
          
            log
            
            
          
           
      Package log provides logging routines based on slog package. 
         | 
      Package log provides logging routines based on slog package. | 
| 
         
          
            utils/docker
            
            
          
           
      Package docker implements Docker utils. 
         | 
      Package docker implements Docker utils. | 
 Click to show internal directories. 
   Click to hide internal directories.