Skip to content
Snippets Groups Projects

New read me how to develop on faidare

1 file
+ 25
9
Compare changes
  • Side-by-side
  • Inline
+ 25
9
@@ -49,7 +49,6 @@ docker compose up
- Kibana available at http://127.0.0.1:5601
Note: Prepare your Elasticsearch indices before proceeding.
--------
## Running the Backend Server
@@ -106,6 +105,17 @@ Before all, take care to get data locally before running any indexing script.
### Indexing Commands Per Operating System
The FAIDARE Docker image uses Alpine Linux as the base, which can lead to compatibility issues on certain systems, such as macOS with ARM processors (Apple Silicon). Below are the specific instructions for running the indexing command on Linux, macOS, and Windows:
#### Finding the Container for `--network`
To determine the name of the container to use with the `--network=container:<container_name>` option, run the following command:
```sh
docker ps
```
This will list all running containers. Look for the container name in the NAMES column. For example, if the container name is `elasticsearch-faidare`, you would use it as follows:
```sh
--network=container:elasticsearch-faidare
```
1. Linux
Run the command as is:
@@ -131,7 +141,7 @@ docker run -t --volume C:/path/to/local/data:/opt/data/ --network=container:elas
```
Remove the `--help` parameter to run the loading with default params.
To more help add `--help` parameter to the command.
If you depend on committed changes in indexing scripts under a specific branch (the docker image should have been automatically created by the CI), you need to change the tag of the docker image according to the branch name (ie. for branch `epic/merge-faidare-dd`, use tag `epic-merge-faidare-dd`, see `CI_COMMIT_REF_SLUG` [Gitlab predefined variable](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html#predefined-variables-reference)), as following:
@@ -143,7 +153,7 @@ docker run -t --volume /path/to/local/data:/opt/data/ --network=container:elasti
#### Docker
[Data Harvesting and Indexing](#Data Harvesting and Indexing) section above expects to have an available docker image on the forgemia docker registry. The Gitlab CI rebuil it when needed, but you can update or push such an image using the following commands:
[Data Harvesting and Indexing](#Data Harvesting and Indexing) section above expects to have an available docker image on the forgemia docker registry. The Gitlab CI rebuild it when needed, but you can update or push such an image using the following commands:
```sh
# build the image
@@ -165,19 +175,25 @@ automatically run the tests of the project (no need to do anything).
If you want to run the GitLab CI locally, you have to follow this steps:
1. [Install gitlab-runner](https://docs.gitlab.com/runner/install/)
2. Run the following command (with the correct GnpIS security token):
### Important:
The `gitlab-runner exec` command was fully removed in GitLab Runner 16.0 and is no longer available in version 17.0 (released May 2024). This command was deprecated in GitLab 15.7 (December 2022), and its removal was part of the breaking changes introduced in GitLab Runner 16.0.
```sh
gitlab-runner exec docker test
```
For more information, see the official [deprecation notice](https://docs.gitlab.com/ee/update/deprecations.html?utm_source=chatgpt.com#the-gitlab-runner-exec-command-is-deprecated).
### Alternatives to gitlab-runner exec:
1. Use the Validate option on GitLab
GitLab provides an integrated Pipeline Editor that allows you to validate and simulate the execution of your .gitlab-ci.yml file before actually running the pipeline.
To use this feature, go to CI/CD > Pipelines > Editor in your GitLab project. Here, you can paste your .gitlab-ci.yml file and click the Validate button to check the syntax and simulate its execution.
2. Emulators
While gitlab-runner exec is deprecated, third-party tools and emulators can help simulate GitLab CI pipelines locally. These tools may be useful for testing and troubleshooting, though they may not replicate the GitLab CI environment exactly.
## Spring Cloud config
On bootstrap, the application will try to connect to a remote Spring Cloud config server
to fetch its configuration.
The details of this remote server are filled in the `bootstrap.yml` file.
The details of this remote server are filled in the `bootstrap.yml` file. ( TODO: This file is not found un this project )
By default, it tries to connect to the remote server on http://localhost:8888
but it can of course be changed, or even configured via the `SPRING_CONFIG_URI` environment variable.
Loading