@@ -73,9 +73,31 @@ report-back to the HoloLens2 platform.
73
73
Workspace root: ` ./ros/ `
74
74
75
75
System requirements
76
+ * ansible
76
77
* docker
77
78
* docker-compose
78
79
80
+ Some files required from the ` https://data.kitware.com ` Girder service require
81
+ authentication due to their protected nature.
82
+ The environment variable ` GIRDER_API_KEY ` must be defined with a valid API key,
83
+ otherwise an authentication token cannot be retrieved.
84
+
85
+ ## Provision Files
86
+ External large files should be provisioned by running the ansible tool:
87
+
88
+ ansible-playbook -i ansible/hosts.yml ansible/provision_files.yml
89
+
90
+ This may include large files for running the system, like ML model files, or
91
+ other files required for building docker images.
92
+
93
+ This provisioning may require additional configuration and variables set in
94
+ your environment in order to satisfy some permissions:
95
+ * ` GIRDER_API_KEY ` will need to be set in order to acquire protected files from
96
+ ` data.kitware.com ` .
97
+
98
+ The configuration that controls what is staged and where is located
99
+ in the ` ansible/roles/provision-files/vars/main.yml ` file.
100
+
79
101
## Docker-based Workflow
80
102
** Intention** : Use containerization to standardize development and runtime
81
103
environment and practice.
@@ -84,9 +106,9 @@ environment and practice.
84
106
configurations.
85
107
86
108
Docker functionality is located under the ` ./docker/ ` directory.
87
- * ` ros2 -base` provides a base environment that supports building and running
88
- our workspace.
89
- * ` ros2- workspace-build` provides a build of our workspace.
109
+ * ` workspace -base-dev ` provides a base environment that supports building and
110
+ running our workspace.
111
+ * ` workspace-build ` provides a build of our workspace.
90
112
91
113
### Building Docker Images
92
114
Run ` ./angel-docker-build.sh ` .
@@ -103,7 +125,7 @@ The definition of this service is found in the `docker/docker-compose.yml`
103
125
configuration.
104
126
105
127
This will mount the ` ./ros/ ` subtree on the host system into the
106
- ` /angel_workspace/src ` directory in the run container.
128
+ ` /angel_workspace/src/ ` directory in the run container.
107
129
108
130
This "workspace" context additionally mounts build, install and log output
109
131
directories to a spot on the host in order to:
@@ -115,6 +137,9 @@ The script `/angel_workspace/workspace_build.sh` is available to run.
115
137
This script is used during the image build process, so using this script
116
138
ensures that the same build method is performed.
117
139
140
+ Other directories and files are mounted into the container environment for
141
+ development purposes and external file sharing.
142
+
118
143
This shell will ** _ NOT_ ** have the local installation sourced in order to
119
144
facilitate further safe build actions.
120
145
` ros2 run ` actions should be performed in a separate shell from where builds
0 commit comments