Skip to content

Commit

Permalink
Fix links to images
Browse files Browse the repository at this point in the history 
This PR updates the links to the images in the post.

Signed-off-by: Elizabeth Barron <[email protected]>
  • Loading branch information
@ElizabethN
ElizabethN authored Sep 30, 2024
1 parent 75d8b72 commit 2e5be6c
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions archive/Community/News/20191007-install-grimoirelab.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ $ docker-machine --version
```


![1. Screenshot of checking prerequisites](https://raw.githubusercontent.com/chaoss/website/master/Community/News/images/20191007-install-grimoirelab/1-Screenshot-of-checking-prerequisites.png)
![1. Screenshot of checking prerequisites](https://github.com/chaoss/website/blob/main/archive/Community/News/images/20191007-install-grimoirelab/1-Screenshot-of-checking-prerequisites.png)

I found that by default, Docker is not assigned enough resources. Click on the Docker symbol in the top bar of and open Preferences. In the Advanced settings, make sure Docker has enough resources. I found 3 CPUs, 8GB Memory, and 2GB Swap to work for me.


![2. Screenshot of Docker configuration.png](https://raw.githubusercontent.com/chaoss/website/master/Community/News/images/20191007-install-grimoirelab/2-Screenshot-Docker-configuration.png)
![2. Screenshot of Docker configuration.png](https://github.com/chaoss/website/blob/main/archive/Community/News/images/20191007-install-grimoirelab/2-Screenshot-Docker-configuration.png)

Next, we need the docker-compose file and some setting files. They are currently in the [CHAOSS GrimoireLab repository](https://github.com/chaoss/grimoirelab). We need to clone the repository to our local machine. I have my own way of organizing repositories that I clone, but it really does not matter where you store it. The important command to run now are for cloning the repository:

Expand All @@ -43,7 +43,7 @@ $ cd grimoirelab
```


![3. Screenshot of cloning analytics-demo](https://raw.githubusercontent.com/chaoss/website/master/Community/News/images/20191007-install-grimoirelab/3-Screenshot-of-cloning-analytics-demo.png)
![3. Screenshot of cloning analytics-demo](https://github.com/chaoss/website/blob/main/archive/Community/News/images/20191007-install-grimoirelab/3-Screenshot-of-cloning-analytics-demo.png)


GrimoireLab comes with default settings that we want to review. Change directory into `grimoirelab/default-grimoirelab-settings`. The [projects.json](https://github.com/chaoss/grimoirelab/blob/master/default-grimoirelab-settings/projects.json) is configured to collect metrics about the GrimoireLab git repository. Maybe take a look at the relevant [GrimoireLab tutorial section on the projects file](https://chaoss.github.io/grimoirelab-tutorial/sirmordred/projects.html) for details on how the file is built.
Expand All @@ -56,14 +56,14 @@ With the current settings, we would analyze only the git commit history. I am al
]
```

![projects.json with the added lines](https://raw.githubusercontent.com/chaoss/website/master/Community/News/images/20191007-install-grimoirelab/4-Screenshot-of-projects.json.png)
![projects.json with the added lines](https://github.com/chaoss/website/blob/main/archive/Community/News/images/20191007-install-grimoirelab/4-Screenshot-of-projects.json.png)

**Pro-tip:** After editing the projects.json file, send it through a JSON validator (e.g., [JSONLint](https://jsonlint.com/), or [FreeFormatter](https://www.freeformatter.com/json-validator.html)) to check for syntax errors.

Next, we need to make sure that we have API access tokens set up correctly in the [setup.cfg](https://github.com/chaoss/grimoirelab/blob/master/default-grimoirelab-settings/setup.cfg) file. The projects.json specifies only `git` as data sources. To activate data collection for GitHub issues and pull requests, we have to un-comment the relevant section. For this, [GitHub requires an API token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line#creating-a-token), which can be generated in your [GitHub settings > Developer settings > Personal access tokens](https://github.com/settings/tokens). We can generate the API token without selecting a scope (i.e., do not check any boxes).


![5. Screenshot for GitHub API YOUR_API_TOKEN_HERE](https://raw.githubusercontent.com/chaoss/website/master/Community/News/images/20191007-install-grimoirelab/5-Screenshot-for-GitHub-API-token.png)
![5. Screenshot for GitHub API YOUR_API_TOKEN_HERE](https://github.com/chaoss/website/blob/main/archive/Community/News/images/20191007-install-grimoirelab/5-Screenshot-for-GitHub-API-token.png)

Now, we have configured GrimoireLab to begin collecting data. We configured what projects to collect data for the [projects.json](https://github.com/chaoss/grimoirelab/blob/master/default-grimoirelab-settings/projects.json) and configured our access to the relevant data sources in the [setup.cfg](https://github.com/chaoss/grimoirelab/blob/master/default-grimoirelab-settings/setup.cfg).

Expand All @@ -77,15 +77,15 @@ $ docker-compose up -d
The first time we run this command, several downloads are started. Grab a coffee refill while we wait for the “done” signal.


![7. Screenshot of done signal](https://raw.githubusercontent.com/chaoss/website/master/Community/News/images/20191007-install-grimoirelab/7-Screenshot-of-done-signal.png)
![7. Screenshot of done signal](https://github.com/chaoss/website/blob/main/archive/Community/News/images/20191007-install-grimoirelab/7-Screenshot-of-done-signal.png)


If you get an error, try running `docker-compose up` without the `-d` flag. That will output all messages and give some insights to problems. For example, if an error reads something like “Error starting proxy: listen tcp 0.0.0.0:3306: bind: address already in use”, then you already have a program listening on a port, in this case port 3306 which would be the case if you are running an [AMP](https://en.wikipedia.org/wiki/List_of_Apache%E2%80%93MySQL%E2%80%93PHP_packages) with MySQL. In the scope of this blog post, I can only point out that this could be an issue but I have to assume that you can work through it yourself.

Once your containers are all started successfully, go to your favorite browser and look at the status by going to http://localhost:5601


![8. Screenshot of status page with error](https://raw.githubusercontent.com/chaoss/website/master/Community/News/images/20191007-install-grimoirelab/8-Screenshot-of-status-page-with-error.png)
![8. Screenshot of status page with error](https://github.com/chaoss/website/blob/main/archive/Community/News/images/20191007-install-grimoirelab/8-Screenshot-of-status-page-with-error.png)

Let me guess, the Elasticsearch container is not running. This is a known problem, and a [solution is documented in the elastic documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html#docker-cli-run-prod-mode). To resolve the issue, run on your Mac ([read the doc for other operating systems](https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html#docker-cli-run-prod-mode)):

Expand Down

0 comments on commit 2e5be6c

Please sign in to comment.