Skip to content

Latest commit

 

History

History
90 lines (68 loc) · 4.07 KB

SETUP.md

File metadata and controls

90 lines (68 loc) · 4.07 KB

Setup

Access to BDC artifactory

Please follow the steps below to setup your environment

  1. Please Raise a IDM request via the Bosch IDM Portal to access the repo – for role - BDC_Artifactory_01_perm400_user
  2. Once the request is done, go to https://artifactory.boschdevcloud.com/ and click the Button "SAML SSO" on the bottom
  3. Go to the artifacts (menu on the left side)
  4. Filter for sdv-bgsw-conan-virtual
  5. Click on the Button "Set me up" in the top right corner
  6. In the configure-tab click on "Generate Token & Create Instructions"
  7. Copy the token
  8. In the repository's root folder create a file called .credentials with following content: 
    CONAN_REMOTE_USER=<nt-user-id>
CONAN_REMOTE_TOKEN=<your-token>
  9. Reopen the folder in a container

After performing the above steps, the basic setup is now done.

Tailoring the template

If you want to, you can customize your setup to fully fit your needs.

Configuring mirrors and URLs

Velocitas toolchain packages

The project configuration file .velocitas.json contains soft references to repositories on Github.com via the packages object:

{
    "packages": {
        "devenv-runtimes": "v4.0.5",
        "devenv-github-workflows": "v6.0.4",
        "devenv-github-templates": "v1.0.5",
        "devenv-devcontainer-setup": "v2.4.6"
    },
    <...>
}

Unless the key of the package contains a fully qualified URL, the key will resolve to https://github.com/eclipse-velocitas/<key>.git.

In case you have set-up your own mirrors of the packages, you can reference those mirrors by providing fully qualified URLs:

e.g.

{
    "packages": {
        "https://github.com/SoftwareDefinedVehicle/devenv-runtimes.git": "v4.0.5",
        "https://github.com/SoftwareDefinedVehicle/devenv-github-workflows.git": "v6.0.4",
        "https://github.com/SoftwareDefinedVehicle/devenv-github-templates.git": "v1.0.5",
        "https://github.com/SoftwareDefinedVehicle/devenv-devcontainer-setup.git": "v2.4.6"
    },
    <...>
}

Project variables

There are also several project variables which can be set in the .velocitas.json. Here are some examples:

Variable Purpose Example
gitLocation Base Git location to be used instead of https://github.com/eclipse-velocitas for ALL git references which are not configurable elsewhere. https://github.com/SoftwareDefinedVehicle
mqttBrokerImage URL of a custom MQTT Broker Docker Container registry.hub.docker.com/library/eclipse-mosquitto:2.0.14
vehicleDatabrokerImage URL of a custom Databroker Docker Container ghcr.io/eclipse-kuksa/kuksa-databroker:0.4.4
mockServiceImage URL of a custom Mockservice Docker Container ghcr.io/eclipse-kuksa/kuksa-mock-provider/mock-provider:0.4.0,
sdkGitRepo Git-URL of a custom Vehicle SDK which shall be used instead of https://github.com/eclipse-velocitas/vehicle-app-cpp-sdk.git https://github.com/SoftwareDefinedVehicle/vehicle-app-cpp-sdk.git

An exhaustive list of all possible project variables can be obtained by executing velocitas package in a terminal or by looking at the manifest files of the used Velocitas packages.

This project contains a convenience script which can be executed to configure needed variables.

  • Reconfigure template URLs

    1. Open the reconfigure_template_urls.sh script.
    2. Adapt all the variables in the marked area (GIT_FORK_LOCATION, PIP_MIRROR, BASE_IMAGE_URL, VSS_PATH, MQTT_IMAGE, DATABROKER_IMAGE, MOCKSERVICE_IMAGE).
    3. Execute the script from a Linux host (tested under Ubuntu). This host may be a VM or DevContainer. 
      ./reconfigure_template_urls.sh

Configuring Vehicle mock behavior

A customized mock.py is already part of this repository, feel free to adapt it to the needs of your app. It uses a Python based DSL to describe the mocking behavior. Refer to the KUKSA mock provider documentation for details.