You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Secure Auth takes precedence over environment variables and if supported config plaintext values are evaluated last.
95
+
96
+
i.e.:
97
+
98
+
1. Secure location is checked first
99
+
2. Env is looked up for any matching values
100
+
3. Config auth is checked last (No longer supported in +0.9.0)
101
+
{{< /callout >}}
94
102
95
-
### Import / Download Dashboards
103
+
## Download Dashboards
96
104
97
105
Minimal configuration (eg. the `gdg.yml` file) that you need to download your dashboards from your Grafana endpoint:
98
106
@@ -102,26 +110,33 @@ context_name: all
102
110
contexts:
103
111
all:
104
112
url: https://grafana.example.org
105
-
token: "<<Grafana API Token>>"
106
-
# user_name: admin
107
-
# password: admin
113
+
user_name: admin # Omit if using tokens
108
114
output_path: exports
109
115
watched:
110
116
- Example
111
117
- Infrastructure
118
+
- MyFolder/.*
119
+
- Some+Folder+With+Spaces/subfolder
120
+
# Either use dashboard_settings.ignore_filters=true or watched folders.
121
+
## The setting below will ignore all watched folders fetch everything.
122
+
dashboard_settings:
123
+
ignore_filters: false # When set to true all Watched filtered folders will be ignored and ALL folders will be acted on
112
124
113
125
global:
114
126
debug: true
115
127
ignore_ssl_errors: false
116
128
```
117
129
You need to adjust three parts in the configuration in order to function:
118
130
- Grafana URL: This is just a URL where your Grafana is available.
119
-
- API Key OR Username / Passoword for Admin user. See [authentication](configuration.md) section if you need more information.
120
-
- Downloaded Folders: The `watched` field defines folders which will be considered for manipulation. You can see these folders in your Grafana Web UI, under Dashboards > Management. From there, you can simply define the folders you want to be downloaded in the `watched` list. The dashboards are downloaded as JSON files in the `$OUTPUT_PATH/dashboards/$GRAFANA_FOLDER_NAME` directory. Where `$OUTPUT_PATH` is the path defined in the `dashboard_output` configuration property and `$GRAFANA_FOLDER_NAME` the name of the folder from which the dashboards were downloaded.
131
+
- Set the user_name to the value you want to use.
132
+
- You need to either set a ENV value or create an auth_<context_name> with the correct values for your token or password.
133
+
- API Key OR Username / Password for Admin user. See [authentication](#authentication-concepts) section above if you need more information.
134
+
- Downloaded Folders: The `watched` field defines folders which will be considered for manipulation. You can see these folders in your Grafana Web UI, under Dashboards > Management. From there, you can simply define the folders you want to be downloaded in the `watched` list. The dashboards are downloaded as JSON files in the `$OUTPUT_PATH/org_name/dashboards/$GRAFANA_FOLDER_NAME` directory. Where `$OUTPUT_PATH` is the path defined in the `output_path` configuration property and `$GRAFANA_FOLDER_NAME` the name of the folder from which the dashboards were downloaded.
135
+
- The default org_name is "Main Org." which is the default for Grafana, if you renamed your org, please set its name with the property: `organization_name`
After executing `./bin/gdg dash import` you can find the dashboards of the `Infrastructure` folder in the local directory `dashboards/dashboards/Infrastructure` and the dashboards of the `Example` directory in the local directory `dashboards/dashboards/Example`.
158
+
After executing `./bin/gdg backup dash download` you can find the dashboards of the `Infrastructure` folder in the local directory `org_main-org/dashboards/Infrastructure` and the dashboards of the `Example` directory in the local directory `org_main-org/dashboards/Example`.
144
159
145
-
### Export / Upload Dashboards
160
+
## Upload Dashboards
146
161
147
-
Minimal configuration (eg. the `gdg.yml` file) that you need to upload your dashboards from your Grafana endpoint:
162
+
Minimal configuration (i.e. the `gdg.yml` file) that you need to upload your dashboards from your Grafana endpoint:
148
163
```yaml
149
164
context_name: all
150
165
@@ -153,7 +168,6 @@ contexts:
153
168
url: https://grafana.example.org
154
169
token: "<<Grafana API Token>>"
155
170
# user_name: admin
156
-
# password: admin
157
171
output_path: exports
158
172
watched:
159
173
- Example
@@ -165,8 +179,8 @@ global:
165
179
```
166
180
You need to adjust three parts in the configuration in order to function:
167
181
- Grafana URL: This is just a URL where your Grafana is available.
168
-
- API Key OR Username / Passoword for Admin user. See [authentication](configuration.md) section if you need more information.
169
-
- Uploaded Folders: The `watched` field defines folders which will be considered for manipulation. The dashboards should be stored as JSON files in the `$OUTPUT_PATH/dashboards/$GRAFANA_FOLDER_NAME` directory. Where `$OUTPUT_PATH` is the path defined in the `dashboard_output` configuration property and `$GRAFANA_FOLDER_NAME` the name of the folder to which the dashboards will be uploaded. In case of the above configuration file, the dashboards should be stored locally in the `dashboards/dashboards/Example` and `dashboards/dashboards/Infrastructure/` directories.
182
+
- API Key OR Username / Password for Admin user. See [authentication](configuration.md) section if you need more information.
183
+
- Uploaded Folders: The `watched` field defines folders which will be considered for manipulation. The dashboards should be stored as JSON files in the `$OUTPUT_PATH/$ORG_NAME/dashboards/$GRAFANA_FOLDER_NAME` directory. Where `$OUTPUT_PATH` is the path defined in the `output_path` configuration property and `$GRAFANA_FOLDER_NAME` the name of the folder to which the dashboards will be uploaded. In case of the above configuration file, the dashboards should be stored locally in the `exports/org_main-org/dashboards/Example` and `exports/org_main-org/dashboards/Infrastructure/` directories.
170
184
171
185
```sh
172
186
├── bin
@@ -179,4 +193,4 @@ You need to adjust three parts in the configuration in order to function:
179
193
| └─ Infrastructure
180
194
| └── aws-ecs.json
181
195
```
182
-
You can execute `./bin/gdg backup dash export` to upload the local dashboards to your Grafana. Afterwards, you can try running `./bin/gdg dash list` in order to confirm that your dashboards were uploaded successfully.
196
+
You can execute `./bin/gdg backup dash upload` to upload the local dashboards to your Grafana. Afterwards, you can try running `./bin/gdg dash list` in order to confirm that your dashboards were uploaded successfully.
Copy file name to clipboardExpand all lines: website/content/docs/releases/gdg_0.9.md
+14Lines changed: 14 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,20 @@ weight: 2
8
8
toc: true
9
9
---
10
10
11
+
## Release Notes for v0.9.3
12
+
13
+
### Changes
14
+
15
+
### BugFixes
16
+
-[#543](https://github.com/esnet/gdg/issues/543) Env vars not working due to a conflict with the secure_location pattern that was previously introduced. Env will work if secure location not used. Next major release (0.10.x) will fix this to allow for Env to take precedence over any config values.
17
+
18
+
## TechDebt
19
+
- Bug [#501](https://github.com/esnet/gdg/issues/501) Fixing issues with test failures due to containers not being available.
20
+
-[#539](https://github.com/esnet/gdg/issues/539) Added test to cover to plugin code path.
21
+
-[#488](https://github.com/esnet/gdg/issues/488) Added an Env to disable enterprise tests. Allow contributors to not be blocked without a license.
22
+
-[#531](https://github.com/esnet/gdg/issues/531) Fixing documentation issues with the Getting Started guide and css/icons rendering behavior.
23
+
- General dependency and tooling update, upgrade to go 1.26.0, npm updates
24
+
11
25
## Release Notes for v0.9.2
12
26
13
27
This is a quick bug fix release to address the behavior of alert rules. The other changes are enabling encryption for
0 commit comments