README
¶
FF-Proxy
The Relay Proxy is a lightweight Go application that runs within your infrastructure and handles all streaming connections to the Harness platform. It fetches all of your flag, target, and target group data on startup, caches it, fetches any updates over time, and serves it to your connected downstream SDKs.
Getting Started
To learn more about deploying the relay proxy see Deploy the Relay Proxy.
Why use the Relay Proxy?
To read more about use cases and advantages of the Relay Proxy see the Why use the Relay Proxy?.
You can also read more about the use cases, architecture and more in our blog post.
Configuration
To view the many configuration options available read Configuration.
TLS
To view how to securely connect sdks to the Relay Proxy with HTTPS enabled see TLS.
Redis Cache
By default the Relay Proxy runs with an In Memory Cache.
To run with persistent storage in redis read Redis.
Offline Mode
If you'd like to run the Relay Proxy in airgapped environments or locations with poor internet reliability you can generate offline flag configuration and run the Relay Proxy in a fully offline mode. To learn more read Offline Mode.
Load Balancing
For info on horizontal scaling Relay Proxies and a working example see Load Balancing.
Windows
If you'd like to build and run the Relay Proxy on Windows see Windows.
Endpoints
For info on the external Harness SaaS endpoints the Relay Proxy communicates with see Outbound Endpoints. For info on the Relay Proxy endpoints your sdks will connect to see Inbound Endpoints.
Debugging
For help on debugging your Relay Proxy install see Debugging.
Contributing
See the contribution guide.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type FileDecoder ¶
type FileDecoder struct {
// contains filtered or unexported fields
}
FileDecoder is a type that can be used to decodes files of different formats into a go type.
func NewFileDecoder ¶
func NewFileDecoder(fileSystem fs.FS, file string) (*FileDecoder, error)
NewFileDecoder opens the file and creates a decoder based on the file extension. If the file extension is not supported it returns an error. NewFileDecoder does not close the opened file, for the file to be closed you have to call the Decode method.
func (*FileDecoder) Decode ¶
func (f *FileDecoder) Decode(v interface{}) error
Decode decodes the contents of the file into v and closes it
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
gen
|
|
|
admin
Package admin provides primitives to interact with the openapi HTTP API.
|
Package admin provides primitives to interact with the openapi HTTP API. |
|
client
Package client provides primitives to interact with the openapi HTTP API.
|
Package client provides primitives to interact with the openapi HTTP API. |
|
tests
|
|