All rapyuta.io docs are open source. See something that's wrong or unclear? Submit a pull request.
Make a contributionTo create a build using the Catkin or Docker recipe:
In the rapyuta.io console, on the left navigation bar, click Development > Builds.
Click ADD NEW BUILD.
In the Create new build dialog, under Git info, enter:
| Field | Description |
|---|---|
| Name | Enter a build name. The name should only contain alphanumeric characters, underscore and hyphen. It should not start with a digit and the length should be between 3 and 75 characters. |
| Build Recipe | Select Catkin or Docker. |
| Repository (URL) | Enter the URL of the git repository from which you want to create a build. For example, https://github.com/rapyuta/io_tutorials. |
| Branch | Enter the branch name of the repository for the build. In the Branch field, you can also provide any Git reference as valid input. For example, Commit ID, Tag name, or Branch name. If you don’t specify any branch name in the Branch field, then the default branch name of the repository is considered. |
| Private Git | Enable the Private Git toggle button if it is a private git repository. Additionally, select the Credentials from the dropdown list. To create a secret for the repository, see Create a Source Secret. |
| Context Directory | Enter the directory path to create the build. |
Click Next.
Under Build Info, enter:
| Field | Description |
|---|---|
| Architecture | Select the processor architecture for the build. The available options are; arm32v7, arm32v7, or amd64. |
| Dockerfile Path (applicable only for Docker recipe) | Enter the path of the docker file that contains the source code. The docker file path is relative to the Context Directory field. |
| Has ROS Components (applicable only for Docker recipe) | Enable if the build has ROS components. |
| Has Simulation | Enable the Has Simulation toggle button if the build has a simulation. |
| ROS Version | Select either Kinetic or Melodic. As Kinetic has reached the EOL, it is suggested to select Melodic as the ROS version while creating a build. |
| Add Parameter (applicable only for Catkin recipe) | Select this option to add ROS parameter to the build. For more information about adding parameters, see Builds: ROS Support. |
Click Next.
rapyuta.io platform allows you to push and save the build image to an external docker registry or to pull an image from a private repository. Under Docker Secret, enter:
| Field | Description |
|---|---|
| Docker Pull Secret (applicable only for Docker recipe) | Enable and select the secret for the repository if you want to pull a secured docker image to the docker file. You can enable this option if the docker file requires a base image from the private registry. To create a secret for the repository, see Create a Secret. |
| Docker Push Secret | Enable if you want to push the build image to a private registry and select the secret for the repository. To create a secret for the repository, see Create a Secret. |
| Image Repository | Enter the URL of the private repository where you want to push and save the image for later usage. For example, docker.io/your-username/repo-name. |
| Push Secret | Select the secret from the dropdown list. To create a secret for the repository, see Create a Source Secret. |
| Trigger Name | Enter a name for the trigger. This is used to identify the build requests. |
| Tag Name | The tag name is an optional field and can be used as a docker tag in the external docker registry. |
| Same as Trigger Name | Select this checkbox if you wish to use the Trigger Name as the Tag Name. |
The Build History tab displays the trigger/tag name added during the build creation. If you haven’t added any trigger name to the build, it displays a default trigger name.
After you have created a build by either Catkin or Docker recipe, you can view the details of the available builds in your project.
To view the details of a build:
The following table displays the details of the available builds.
| Field | Description |
|---|---|
| Name/ID | Specifies the name of the build. |
| Status | Specifies the build status.
|
| Started | Provides the time at which the build creation process started. |
| Repository | Provides the repository from which the build has been created. |
| Action | Allows you to delete, trigger, or clone a build. |
If the build Status is BuildInProgress, you cannot Delete the build. Deletion of such builds will fail with the error message: can’t delete the build since its corresponding build request is still in progress.
Click Trigger to trigger a build.
Click Clone to clone a build within the same or to different projects. This reduces the time and effort to create a build from scratch.
Note:
Click Edit to update the details of the build.
Note:
Click More to view the build details.