|
8 | 8 |
|
9 | 9 | ## What is ddev-grafana? |
10 | 10 |
|
11 | | -This repository is a template for providing [DDEV](https://ddev.readthedocs.io) add-ons and services. |
| 11 | +This repository provides Grafana stack addon to [DDEV](https://ddev.readthedocs.io). |
12 | 12 |
|
13 | | -In DDEV addons can be installed from the command line using the `ddev get` command, for example, `ddev get ddev/ddev-grafana` or `ddev get ddev/ddev-drupal9-solr`. |
| 13 | +It contains several components from Grafana stack: |
14 | 14 |
|
15 | | -A repository like this one is the way to get started. You can create a new repo from this one by clicking the template button in the top right corner of the page. |
| 15 | +- **[Grafana](https://grafana.com/grafana/)**: an open source analytics and interactive visualization web application. It provides charts, graphs, and alerts for the web when connected to supported data sources. |
16 | 16 |
|
17 | | - |
| 17 | +- **[Prometheus](https://prometheus.io/)**: an open source monitoring solution written in Go that collects metrics data and stores that data in a time series database. |
18 | 18 |
|
19 | | -## Components of the repository |
| 19 | +- **[Loki](https://grafana.com/logs/)**: a horizontally scalable, highly available, multi-tenant log aggregation solution. |
20 | 20 |
|
21 | | -* The fundamental contents of the add-on service or other component. For example, in this template there is a [docker-compose.grafana.yaml](docker-compose.grafana.yaml) file. |
22 | | -* An [install.yaml](install.yaml) file that describes how to install the service or other component. |
23 | | -* A test suite in [test.bats](tests/test.bats) that makes sure the service continues to work as expected. |
24 | | -* [Github actions setup](.github/workflows/tests.yml) so that the tests run automatically when you push to the repository. |
| 21 | +- **[Tempo](https://grafana.com/traces/)**: an open source, easy-to-use, and high-scale distributed tracing backend. |
25 | 22 |
|
26 | | -## Getting started |
| 23 | +## Installation |
27 | 24 |
|
28 | | -1. Choose a good descriptive name for your add-on. It should probably start with "ddev-" and include the basic service or functionality. If it's particular to a specific CMS, perhaps `ddev-<CMS>-servicename`. |
29 | | -2. Create the new template repository by using the template button. |
30 | | -3. Globally replace "grafana" with the name of your add-on. |
31 | | -4. Add the files that need to be added to a ddev project to the repository. For example, you might remove `docker-compose.grafana.yaml` with the `docker-compose.*.yaml` for your recipe. |
32 | | -5. Update the install.yaml to give the necessary instructions for installing the add-on. |
| 25 | +1. In the DDEV project directory launch the command: |
| 26 | +``` |
| 27 | +ddev get MurzNN/ddev-grafana |
| 28 | +``` |
| 29 | +2. Restart the DDEV instance: |
| 30 | +``` |
| 31 | +ddev restart |
| 32 | +``` |
| 33 | +3. Open the Grafana web interface via the url: http://your-project-name.ddev.site:3000/ |
33 | 34 |
|
34 | | - * The fundamental line is the `project_files` directive, a list of files to be copied from this repo into the project `.ddev` directory. |
35 | | - * You can optionally add files to the `global_files` directive as well, which will cause files to be placed in the global `.ddev` directory, `~/.ddev`. |
36 | | - * Finally, `pre_install_commands` and `post_install_commands` are supported. These can use the host-side environment variables documented [in ddev docs](https://ddev.readthedocs.io/en/stable/users/extend/custom-commands/#environment-variables-provided). |
37 | | - |
38 | | -6. Update `tests/test.bats` to provide a reasonable test for the repository. You can run it manually with `bats tests` and it will be run on push and nightly as well. Please make sure to attend to test failures when they happen. Others will be depending on you. `bats` is a simple testing framework that just uses `bash`. You can install it with `brew install bats-core` or [see other techniques](https://bats-core.readthedocs.io/en/stable/installation.html). See [bats tutorial](https://bats-core.readthedocs.io/en/stable/). |
39 | | -7. When everything is working, including the tests, you can push the repository to GitHub. |
40 | | -8. Create a release on GitHub. |
41 | | -9. Test manually with `ddev get <owner/repo>`. |
42 | | -10. You can test PRs with `ddev get https://github.com/<user>/<repo>/tarball/<branch>` |
43 | | -11. Update the README.md to describe the add-on, how to use it, and how to contribute. If there are any manual actions that have to be taken, please explain them. If it requires special configuration of the using project, please explain how to do those. Examples in [ddev/ddev-drupal9-solr](https://github.com/ddev/ddev-drupal9-solr), [ddev/ddev-memcached](github.com/ddev/ddev-memcached), and [ddev/ddev-beanstalkd](https://github.com/ddev/ddev-beanstalkd). |
44 | | -12. Add a good short description to your repo, and add the label "ddev-get". It will immediately be added to the list provided by `ddev get --list --all`. |
45 | | -13. When it has matured you will hopefully want to have it become an "official" maintained add-on. Open an issue in the [ddev queue](https://github.com/ddev/ddev/issues) for that. |
46 | | - |
47 | | -Note that more advanced techniques are discussed in [DDEV docs](https://ddev.readthedocs.io/en/latest/users/extend/additional-services/#additional-service-configurations-and-add-ons-for-ddev). |
48 | | - |
49 | | -**Contributed and maintained by [@CONTRIBUTOR](https://github.com/CONTRIBUTOR) based on the original [ddev-contrib recipe](https://github.com/ddev/ddev-contrib/tree/master/docker-compose-services/RECIPE) by [@CONTRIBUTOR](https://github.com/CONTRIBUTOR)** |
50 | | - |
51 | | -**Originally Contributed by [somebody](https://github.com/somebody) in <https://github.com/ddev/ddev-contrib/> |
| 35 | +**Contributed and maintained by [@MurzNN](https://github.com/MurzNN). |
0 commit comments