mirror of
https://github.com/zitadel/zitadel
synced 2024-11-22 00:39:36 +00:00
09b021b257
* feat: Configurable Unique Machine Identification This change fixes Segfault on AWS App Runner with v2 #3625 The change introduces two new dependencies: * github.com/drone/envsubst for supporting AWS ECS, which has its metadata endpoint described by an environment variable * github.com/jarcoal/jpath so that only relevant data from a metadata response is used to identify the machine. The change ads new configuration (see `defaults.yaml`): * `Machine.Identification` enables configuration of how machines are uniquely identified - I'm not sure about the top level category `Machine`, as I don't have anything else to add to it. Happy to hear suggestions for better naming or structure here. * `Machine.Identifiation.PrivateId` turns on or off the existing private IP based identification. Default is on. * `Machine.Identification.Hostname` turns on or off using the OS hostname to identify the machine. Great for most cloud environments, where this tends to be set to something that identifies the machine uniquely. Enabled by default. * `Machine.Identification.Webhook` configures identification based on the response to an HTTP GET request. Request headers can be configured, a JSONPath can be set for processing the response (no JSON parsing is done if this is not set), and the URL is allowed to contain environment variables in the format `"${var}"`. The new flow for getting a unique machine id is: 1. PrivateIP (if enabled) 2. Hostname (if enabled) 3. Webhook (if enabled, to configured URL) 4. Give up and error out. It's important that init configures machine identity first. Otherwise we could try to get an ID before configuring it. To prevent this from causing difficult to debug issues, where for example the default configuration was used, I've ensured that the application will generate an error if the module hasn't been configured and you try to get an ID. Misc changes: * Spelling and gramatical corrections to `init.go::New()` long description. * Spelling corrections to `verify_zitadel.go::newZitadel()`. * Updated `production.md` and `development.md` based on the new build process. I think the run instructions are also out of date, but I'll leave that for someone else. * `id.SonyFlakeGenerator` is now a function, which sets `id.sonyFlakeGenerator`, this allows us to defer initialization until configuration has been read. * Update internal/id/config.go Co-authored-by: Alexei-Barnes <82444470+Alexei-Barnes@users.noreply.github.com> * Fix authored by @livio-a for tests Co-authored-by: Livio Amstutz <livio.a@gmail.com>
47 lines
1.1 KiB
Go
47 lines
1.1 KiB
Go
package id
|
|
|
|
const (
|
|
DefaultWebhookPath = "http://metadata.google.internal/computeMetadata/v1/instance/id"
|
|
)
|
|
|
|
type Config struct {
|
|
// Configuration for the identification of machines.
|
|
Identification Identification
|
|
}
|
|
|
|
type Identification struct {
|
|
// Configuration for using private IP to identify a machine.
|
|
PrivateIp PrivateIp
|
|
// Configuration for using hostname to identify a machine.
|
|
Hostname Hostname
|
|
// Configuration for using a webhook to identify a machine.
|
|
Webhook Webhook
|
|
}
|
|
|
|
type PrivateIp struct {
|
|
// Try to use private IP when identifying the machine uniquely
|
|
Enabled bool
|
|
}
|
|
|
|
type Hostname struct {
|
|
// Try to use hostname when identifying the machine uniquely
|
|
Enabled bool
|
|
}
|
|
|
|
type Webhook struct {
|
|
// Try to use webhook when identifying the machine uniquely
|
|
Enabled bool
|
|
// The URL of the metadata endpoint to query
|
|
Url string
|
|
// (Optional) A JSONPath expression for the data to extract from the response from the metadata endpoint
|
|
JPath *string
|
|
// (Optional) Headers to pass in the metadata request
|
|
Headers *map[string]string
|
|
}
|
|
|
|
func Configure(config *Config) {
|
|
if config != nil {
|
|
GeneratorConfig = config
|
|
}
|
|
}
|