Merge pull request #210 from vchrombie/dev-setup-troubleshooting-cleanup

Add language tag for code blocks

Author: vchrombie

docs/getting-started/dev-setup.md

@@ -58,7 +58,7 @@ required. You are also expected to update the configurations in the `setup.cfg`
 file. See [#defining-the-es-configurations](#defining-the-es-configurations).
 
 
-```
+```yml
 elasticsearch:
   image: bitergia/elasticsearch:6.8.6-secured
   command: elasticsearch -Enetwork.bind_host=0.0.0.0 -Ehttp.max_content_length=2000mb
@@ -98,7 +98,7 @@ configurations in the `setup.cfg` file need to be updated. See
 [#defining-the-es-configurations](#defining-the-es-configurations).
 
 
-```
+```yml
 elasticsearch:
   image: docker.elastic.co/elasticsearch/elasticsearch-oss:6.8.6
   command: elasticsearch -Enetwork.bind_host=0.0.0.0 -Ehttp.max_content_length=2000mb
@@ -130,7 +130,7 @@ mariadb:
 ```
 
 Save the above into a docker-compose.yml file and run
-```
+```console
 $ docker-compose up -d
 ```
 to get Elasticsearch, Kibiter and MariaDB running on your system.
@@ -159,7 +159,7 @@ Each local repo should have two `remotes`: `origin` points to the forked repo,
 while `upstream` points to the original CHAOSS repo.
 
 An example is provided below.
-```
+```console
 $ git remote -v
 origin	https://github.com/valeriocos/perceval (fetch)
 origin	https://github.com/valeriocos/perceval (push)
@@ -168,7 +168,7 @@ upstream	https://github.com/chaoss/grimoirelab-perceval (push)
 ```
 
 In order to add a remote to a Git repository, you can use the following command:
-```
+```console
 $ git remote add upstream https://github.com/chaoss/grimoirelab-perceval
 ```
 
@@ -177,7 +177,7 @@ $ git remote add upstream https://github.com/chaoss/grimoirelab-perceval
 You can use this use this
 [script](https://gist.github.com/vchrombie/4403193198cd79e7ee0079259311f6e8) to
 automate this whole process.
-```
+```console
 $ python3 glab-dev-env-setup.py --create --token xxxx --source sources
 ```
 
@@ -231,7 +231,7 @@ and
   required. You are also expected to update the configurations in the
   `setup.cfg` file.
 
-```
+```cfg
 [es_collection]
 url = https://admin:admin@localhost:9200
 
@@ -242,7 +242,7 @@ url = https://admin:admin@localhost:9200
 - For accessing Elasticsearch/Kibiter, no login credentials is required. The
   configurations in the `setup.cfg` file can be updated as below.
 
-```
+```cfg
 [es_collection]
 url = http://localhost:9200
 
@@ -255,7 +255,7 @@ url = http://localhost:9200
 Run the following commands, which will collect and enrich the data coming from
 the git sections and upload the corresponding panels to Kibiter:
 
-```bash
+```console
 micro.py --raw --enrich --cfg ./setup.cfg --backends git cocom
 micro.py --panels --cfg ./setup.cfg
 ```

docs/getting-started/troubleshooting.md

@@ -75,23 +75,23 @@ localhost:9200` messages.
 Diagnosis
 
 Check for the following log in the output of `docker-compose up`
-```
+```console
 elasticsearch_1  | ERROR: [1] bootstrap checks failed
 elasticsearch_1  | [1]: max virtual memory areas vm.max_map_count [65530] is too low, increase to at least [262144]
 ```
 
 Solution
 
 Increase the kernel `max_map_count` parameter of vm using the following command.
-```
-sudo sysctl -w vm.max_map_count=262144
+```console
+$ sudo sysctl -w vm.max_map_count=262144
 ```
 
 Now stop the container services and re-run `docker-compose up`. Note that this
 is valid only for current session. To set this value permanently, update the
 `vm.max_map_count` setting in `/etc/sysctl.conf` file. To verify after
 rebooting, run the below command.
-```
+```console
 $ sysctl vm.max_map_count
 ```
 
@@ -108,7 +108,7 @@ curl: (52) Empty reply from server
 Diagnosis
 
 Check for the following log in the output of `docker-compose up`
-```
+```console
 elasticsearch_1  | [2020-03-12T13:05:34,959][WARN ][c.f.s.h.SearchGuardHttpServerTransport] [Xrb6LcS] Someone (/172.18.0.1:59838) speaks http plaintext instead of ssl, will close the channel
 ```
 
@@ -121,11 +121,11 @@ $ sudo lsof -i:5888
 Solution
 
 1. Try to close the conflicting processes. You can do this easily with fuser
-```
+```console
 $ sudo apt-get install fuser
 ```
 Run the below command (assuming 5888 is the port number)
-```
+```console
 $ fuser -k 58888/tcp
 ```
 Re-run `docker-compose up` and check if `localhost:9200` shows up.'
@@ -145,7 +145,7 @@ Can't create indices in Kibana. Nothing happens after clicking create index.
 Diagnosis
 
 Check for the following log in the output of `docker-compose up`
-```
+```console
 elasticsearch_1 |[INFO ][c.f.s.c.PrivilegesEvaluator] No index-level perm match for User [name=readall, roles=[readall], requestedTenant=null] [IndexType [index=.kibana, type=doc]] [Action [[indices:data/write/index]]] [RolesChecked [sg_own_index, sg_readall]]
 elasticsearch_1 | [c.f.s.c.PrivilegesEvaluator] No permissions for {sg_own_index=[IndexType [index=.kibana, type=doc]], sg_readall=[IndexType [index=.kibana, type=doc]]}
 kibiter_1 | {"type":"response","@timestamp":CURRENT_TIME,"tags":[],"pid":1,"method":"post","statusCode":403,"req":{"url":"/api/saved_objects/index-pattern?overwrite=false","method":"post","headers":{"host":"localhost:5601","user-agent":YOUR_USER_AGENT,"accept":"application/json, text/plain, /","accept-language":"en-US,en;q=0.5","accept-encoding":"gzip, deflate","referer":"http://localhost:5601/app/kibana","content-type":"application/json;charset=utf-8","kbn-version":"6.1.4-1","content-length":"59","connection":"keep-alive"},"remoteAddress":YOUR_IP,"userAgent":YOUR_IP,"referer":"http://localhost:5601/app/kibana"},"res":{"statusCode":403,"responseTime":25,"contentLength":9},"message":"POST /api/saved_objects/index-pattern?overwrite=false 403 25ms - 9.0B"}
@@ -166,11 +166,11 @@ Indication and Diagnosis
 Check for the following error after executing [Micro
 Mordred](https://github.com/chaoss/grimoirelab-sirmordred/tree/master/sirmordred/utils/micro.py)
 using the below command (assuming `git` is the backend)
-```
+```console
 micro.py --raw --enrich --panels --cfg ./setup.cfg --backends git
 ```
 
-```
+```console
 [git] Problem executing study enrich_areas_of_code:git, RequestError(400, 'search_phase_execution_exception', 'No mapping found for [metadata__timestamp] in order to sort on')
 ```
 
@@ -185,7 +185,7 @@ There are 2 solutions to this problem:
 1. Disable the param
    [latest-items](https://github.com/chaoss/grimoirelab-sirmordred/blob/master/sirmordred/utils/setup.cfg#L78)
    by setting it to false.
-```
+```cfg
 latest-items = false
 ```
 2. Delete the local clone of the repo (which is stored in
@@ -215,15 +215,15 @@ again and extract all commits.
 Indication
 
 Cannot open `localhost:9200` in browser, shows `Secure connection Failed`
-```
+```console
 $ curl -XGET localhost:9200 -k
 curl: (7) Failed to connect to localhost port 9200: Connection refused
 ```
 
 Diagnosis
 
 Check for the following log in the output of `docker-compose up`
-```
+```console
 elasticsearch_1  | ERROR: [1] bootstrap checks failed
 elasticsearch_1  | [1]: max file descriptors [4096] for elasticsearch process is too low, increase to at least [65536]
 ```
@@ -232,12 +232,12 @@ Solution
 
 1. Increase the maximum File Descriptors (FD) enforced. You can do this by
    running the below command.
-```
+```console
 $ sysctl -w fs.file-max=65536
 ```
 To set this value permanently, update `/etc/security/limits.conf` content to
 below. To verify after rebooting, run
-```
+```console
 $ sysctl fs.file-max
 ```
 ```
@@ -249,7 +249,7 @@ elasticsearch   memlock unlimited
 2. Override `ulimit` parameters in the Elasticsearch docker configuration. Add
    the below lines to Elasticsearch service in your compose file to override the
    default configurations of docker.
-```
+```yml
 ulimits:
 nofile:
   soft: 65536
@@ -267,7 +267,7 @@ Solution
 
 Enable the `sleep-for-rate` parameter. It increases rate by sleeping between API
 call retries.
-```
+```cfg
 sleep-for-rate = true
 sleep-time = 300
 ```
@@ -294,7 +294,7 @@ Indication
 
 Diagnosis
 
-```
+```console
 Retrying (Retry(total=10,connected=21,read=0,redirect=5,status=None)) after connection broken by 
 'SSLError(SSLError{1,'[SSL: WRONG_VERSION_NUMBER] wrong version number {_ssl.c:852}'},)': /
 ```
@@ -304,7 +304,7 @@ Solution
 Change `https` to `http` in the `setup.cfg` file if you are using the
 Elasticsearch without the SearchGuard. See
 [defining-the-es-configurations](/grimoirelab-tutorial/docs/getting-started/dev-setup/#defining-the-es-configurations).
-```
+```cfg
 [es_collection]
 url = http://localhost:9200
 
@@ -316,7 +316,7 @@ url = http://localhost:9200
 
 Diagnosis
 
-```
+```console
 : [Errno 2]No such file or directory : 'cloc': 'cloc'
 ```
 
@@ -326,7 +326,7 @@ Execute the following command to install `cloc` (more details are available in
 the
 [Graal](https://github.com/chaoss/grimoirelab-graal#how-to-installcreate-the-executables)
 repo).
-```
+```console
 $ sudo apt-get install cloc
 ```