Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove redundant dockerfile, fix documentation #306

Merged
merged 1 commit into from
Nov 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## Developing

The easiest way to work on this datasource is by using [docker compose](./docker-compose.yaml) approach.
First, run the connector:

```
yarn dev
```
And then use another terminal to run the docker

```
yarn server
```

Alternatively, you to create a symbolic link
in `data/plugins` that points to this directory and run Grafana instance separately.

```shell
cd /path/to/grafana/data/plugins
ln -s /path/to/cognite-grafana-datasource cognitedata-datasource
```

## Building

`yarn` followed by `yarn build` should work on systems with a shell.

For debugging and development, use `yarn dev`, and for testing use `yarn test`.
7 changes: 0 additions & 7 deletions Dockerfile

This file was deleted.

38 changes: 2 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,41 +26,7 @@ To learn more about the connector please visit our [documentation](https://docs.

If you find any bugs, or have any suggestions, please [visit support portal](https://support.cognite.com/).

---

## Developing

The easiest way to work on this datasource is to create a symbolic link
in `data/plugins` that points to this directory.

```shell
cd /path/to/grafana/data/plugins
ln -s /path/to/cognite-grafana-datasource cognitedata-datasource
```

## Building

`yarn` followed by `yarn build` should work on systems with a shell.

For debugging and development, use `yarn dev`, and for testing use `yarn test`.

## Docker

The Grafana image is also hosted on Docker Hub as
[cognite/grafana-cdf](https://hub.docker.com/r/cognite/grafana-cdf/) or [cognite/grafana-cdf-dev](https://hub.docker.com/r/cognite/grafana-cdf-dev/) and bundled with a Cognite Data Source. You may use it for development and testing purposes only.

To run it, first create a Docker volume to store your dashboards
and settings.

`docker volume create grafana-storage`

Run the Docker image using this volume:

`docker run -d --name grafana -p 3000:3000 -v grafana-storage:/var/lib/grafana cognite/grafana-cdf`

Now you can access Grafana at http://localhost:3000

Standard username/password for logging in is admin/admin. See
[http://docs.grafana.org/installation/docker/](http://docs.grafana.org/installation/docker/) for configuration details.
## Development

For more help with Docker, see the [step-by-step guide](https://github.com/cognitedata/cognite-grafana-datasource/blob/master/instructions.md).
See [here](./DEVELOPMENT.md)
6 changes: 0 additions & 6 deletions run-cdp.sh

This file was deleted.