https://github.com/steadybit/extension-kit

Official Steadybit ExtensionKit containing utilities that authors of extensions will find helpful
https://github.com/steadybit/extension-kit

Last synced: 5 days ago
JSON representation

Official Steadybit ExtensionKit containing utilities that authors of extensions will find helpful

• Host: GitHub
• URL: https://github.com/steadybit/extension-kit
• Owner: steadybit
• License: mit
• Created: 2022-08-04T13:17:39.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-01-27T15:33:52.000Z (15 days ago)
• Last Synced: 2025-01-29T05:32:35.057Z (13 days ago)
• Language: Go
• Size: 442 KB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# ExtensionKit

Through kits like ActionKit and DiscoveryKit, Steadybit can be extended with new capabilities. Such *Kit usages are

called extensions. ExtensionKit

contains helpful utilities and best practices for extension authors leveraging the Go programming language.

## Installation

Add the following to your `go.mod` file:

```

go get github.com/steadybit/extension-kit

```

## Environment Variables

Extension using this extension kit can be configured through environment variables. The following environment variables

are supported:

| Environment Variable                  | Meaning                                                                                                                                                                | Default |

|---------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|

| `STEADYBIT_EXTENSION_PORT`            | Overwrite the extensions default port number that the HTTP server should bind to.                                                                                      |         |

| `STEADYBIT_EXTENSION_HEALTH_PORT`     | Overwrite the extensions default port number that the HTTP server for the health endpoints should bind to.                                                             |         |

| `STEADYBIT_EXTENSION_TLS_SERVER_CERT` | Optional absolute path to a TLS certificate that will be used to open an **HTTPS** server.                                                                             |         |

| `STEADYBIT_EXTENSION_TLS_SERVER_KEY`  | Optional absolute path to a file containing the key to the server certificate.                                                                                         |         |

| `STEADYBIT_EXTENSION_TLS_CLIENT_CAS`  | Optional comma-separated list of absolute paths to files containing TLS certificates. When specified, the server will expect clients to authenticate using mutual TLS. |         |

| `STEADYBIT_EXTENSION_UNIX_SOCKET`     | If set the extension will listen using a unix domain socket instead of tcp.                                                                                            |         |

| `STEADYBIT_LOG_FORMAT`                | Defines the log format that the extension will use. Possible values are `text` and `json`.                                                                             | text    |

| `STEADYBIT_LOG_LEVEL`                 | Defines the active log level. Possible values are `debug`, `info`, `warn` and `error`.                                                                                 | info    |

| `STEADYBIT_LOG_COLOR`                 | Defines colorization of log output. Possible values are `true`, `false` and unset. If unset will use color only if stderr is a terminal.                               |         |