Skip to content

Commit

Permalink
docs: add config and port info
Browse files Browse the repository at this point in the history 
There is generally some confusion around port mapping therefore
we added docs that explicitley say not to change these values unless
needed as well as give a table of configuration

Signed-off-by: Spazzy <brendankamp757@gmail.com>
  • Loading branch information
@Spazzy757
Spazzy757 committed May 27, 2024
1 parent 3454fd2 commit 6b11ce5
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 5 deletions.
21 changes: 21 additions & 0 deletions docs/docs/config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,27 @@ The name of the config file can be changed by setting the following environment

In the example above the new config file name will be: `aether.yaml`


## Configuration
| value | description | default |
|--------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|
| api.address | The IP address to run on | 0.0.0.0 |
| api.port | The port that aether runs on, please make sure to set the correct values for the containerPort and service if this value changes in kubernetes | 8080 |
| api.metricsPath | The path where you want to serve metrics from | /metrics |
| plugins.exporterDir | The path to load any exporter binary plugins from | /plugins/exporters |
| plugins.sourceDir | The path to load any source binary plugins from | /plugins/sources |
| providersConfig.scrapingInterval | How often aether should fetch metrics and calculate emissions, note its recommended to keep this value unless you understand the implications | 5m |
| providers.gcp.accounts | Google Cloud provider account configuration | [] |
| providers.gcp.accounts.0.project | The google cloud project to scrape metrics for | null |
| providers.gcp.accounts.0.credentials.0.filePaths | The credentials used to scrape the projects, defaults to look for GOOGLE_APPLICATION_CREDENTIALS | null |
| providers.aws.regions | List of regions to read the cloud watch metrics for | [] |
| providers.aws.namespaces | A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html | [] |
| providers.aws.credentials | If the credentials config is empty then, aether will try use the aws sdk default credentials chain: 1. Environment variables. a. Static Credentials (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_SESSION_TOKEN) b. Web Identity Token (AWS_WEB_IDENTITY_TOKEN_FILE) 2. Shared configuration files. a. SDK defaults to credentials file under .aws folder that is placed in the home folder on the computer. b. SDK defaults to config file under .aws folder that is placed in the home folder on the computer. 3. If your application uses an ECS task definition or RunTask API operation, IAM role for tasks. 4. If your application is running on an Amazon EC2 instance, IAM role for Amazon EC2. Otherwise you can specify one or more locations where to look for either the credentials or the config or both | [] |
| providers.aws.credentials.0.profile | The specific profile to load the credentials for | default |
| providers.aws.credentials.0.filePaths | The file paths where the credentials file is located | [] |
| providers.aws.config | Load the config for the specific profile, if not set it uses the [default] profile. | |
| providers.aws.config.profile | The profile to use | default |
| providers.aws.config.filePaths | The file paths where the profile is located | [] |
## Example

```YAML
Expand Down
13 changes: 8 additions & 5 deletions docs/docs/tutorials/installation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,14 @@ helm upgrade --install aether aether/aether -f values.yaml
The default installation has no sources setup, therefore you will need to
configure either using helm values

| value | description | default |
|------------|------------------------------------------------------------------------------|---------|
| secretName | The name of the secret to volume into aether, generally used for credentials | "" |
| config | The yaml config to setup aether with, please see the [config docs][2] | {} |
| | | |
**NOTE**: It is recommended to leave aether running on port 8080 in kubernetes, as changing
this you will need to update the service port in the config as well.

| value | description | default |
|------------ |------------------------------------------------------------------------------ |---------|
| secretName | The name of the secret to volume into aether, generally used for credentials | "" |
| config | The yaml config to setup aether with, please see the [config docs][2] for more information on values that can go under this key | {} |
| service.port | The service port, note this will need to match with `config.api.port` | 8080 |

> Note: If you want metrics to be exported to prometheus you will need to deploy an aether [ServiceMonitor][3].
> More information can be found in the [grafana documentation][4].
Expand Down

0 comments on commit 6b11ce5

Please sign in to comment.