update the default build args to match the latest grpc version, protobuf version and compatible abseil version from ci. Override the base image's entrypoint to support running just an interactive bash session in docker. Add a readme with config details.

Author: dbarker

.devcontainer/Dockerfile.dev

@@ -3,20 +3,19 @@
 
 FROM otel/cpp_format_tools
 
-ARG USER_NAME=devuser
 ARG USER_UID=1000
 ARG USER_GID=1000
 ARG INSTALL_PACKAGES=
 
-ARG CXX_STANDARD=14
-ARG GRPC_VERSION=v1.49.2
-ARG PROTOBUF_VERSION=21.3
-ARG ABSEIL_CPP_VERSION=20240116.1
+ARG CXX_STANDARD=17
+ARG ABSEIL_CPP_VERSION=20230125.3
+ARG PROTOBUF_VERSION=23.3
+ARG GRPC_VERSION=v1.55.0
 
-ENV PROTOBUF_VERSION=${PROTOBUF_VERSION}
+ENV CXX_STANDARD=${CXX_STANDARD}
 ENV ABSEIL_CPP_VERSION=${ABSEIL_CPP_VERSION}
+ENV PROTOBUF_VERSION=${PROTOBUF_VERSION}
 ENV GRPC_VERSION=${GRPC_VERSION}
-ENV CXX_STANDARD=${CXX_STANDARD}
 
 COPY ci /opt/ci
 
@@ -29,23 +28,29 @@ RUN apt update && apt install -y wget \
 RUN cd /opt/ci && bash setup_cmake.sh
 RUN cd /opt/ci && bash setup_ci_environment.sh
 RUN cd /opt && bash ci/setup_googletest.sh \
+    && bash ci/install_abseil.sh \
     && bash ci/install_protobuf.sh \
-    && bash ci/setup_grpc.sh -r $GRPC_VERSION -s $CXX_STANDARD -p protobuf 
+    && bash ci/setup_grpc.sh -r $GRPC_VERSION -s $CXX_STANDARD -p protobuf -p abseil
 
 ADD https://github.com/bazelbuild/bazelisk/releases/download/v1.22.1/bazelisk-linux-amd64 /usr/local/bin
 
 RUN git config --global core.autocrlf input \
 	&& chmod +x /usr/local/bin/bazelisk-linux-amd64
 
 ENV INSTALL_PACKAGES=${INSTALL_PACKAGES}
-ENV USER_NAME=${USER_NAME}
+ENV USER_NAME=devuser
 ENV USER_UID=${USER_UID}
 ENV USER_GID=${USER_GID}
 ENV IS_CONTAINER_BUILD=true
+
 COPY ./.devcontainer/customize_container.sh /tmp/opentelemetry_cpp/devcontainer/customize_container.sh
 RUN /tmp/opentelemetry_cpp/devcontainer/customize_container.sh
-
 RUN apt install -y npm && npm install -g markdownlint-cli
 
-USER ${USER_NAME}
+USER devuser
+
+WORKDIR  /workspaces/opentelemetry-cpp
+
+ENTRYPOINT []
+
 CMD ["/bin/bash"]

.devcontainer/README.md

@@ -0,0 +1,58 @@
+# Customizing Your Dev Container
+
+Customize your dev container using build arguments (for direct Docker builds) or
+environment variables (for evaluation in `devcontainer.json`).
+
+* **CXX standard:**
+  This is the C++ standard to build from (eg: 17, 20, ...). (Default: 17)
+  * Docker ARG:
+   `CXX_STANDARD`
+  * Host Environment Variable:
+   `OTEL_CPP_DEVCONTAINER_CXX_STANDARD`
+
+* **abseil-cpp version:**
+  This is the version of abseil-cpp that will be used to build protobuf, gRPC,
+  and opentelemetry-cpp (when WITH_ABSEIL is set).
+  * Docker ARG:
+   `ABSEIL_CPP_VERSION`
+  * Host Environment Variable:
+   `OTEL_CPP_DEVCONTAINER_ABSEIL_CPP_VERSION`
+
+* **Protobuf version:**
+  * Docker ARG:
+   `PROTOBUF_VERSION`
+  * Host Environment Variable:
+   `OTEL_CPP_DEVCONTAINER_PROTOBUF_VERSION`
+
+* **gRPC version:**
+  * Docker ARG:
+   `GRPC_VERSION`
+  * Host Environment Variable:
+   `OTEL_CPP_DEVCONTAINER_GRPC_VERSION`
+
+* **User ID (UID):**
+  User ID (Default: `1000`)
+  * Docker ARG:
+   `USER_UID`
+  * Host Environment Variable:
+   `OTEL_CPP_DEVCONTAINER_USER_UID`
+
+* **Group ID (GID):**
+  User group ID (Default: `1000`)
+  * Docker ARG:
+   `USER_GID`
+  * Host Environment Variable:
+   `OTEL_CPP_DEVCONTAINER_USER_GID`
+
+* **Install Packages:**
+  These are the additional packages that will be installed via `apt install` in the devcontainer. This is a space separated list.
+  * Docker ARG:
+   `INSTALL_PACKAGES`  (Default: ``)
+  * Host Environment Variable:
+   `OTEL_CPP_DEVCONTAINER_INSTALL_PACKAGES` (Default: ``)
+
+## Examples
+
+* `docker build --build-arg CXX_STANDARD="20" --build-arg INSTALL_PACKAGES="nano gitk"...`
+* `export OTEL_CPP_DEVCONTAINER_CXX_STANDARD=20`
+* `export OTEL_CPP_DEVCONTAINER_INSTALL_PACKAGES="nano gitk"`

.devcontainer/devcontainer.json

@@ -8,14 +8,13 @@
 		"context": "..",
 		"dockerfile": "Dockerfile.dev",
 		"args": {
-			"USER_NAME":"${localEnv:OTEL_CPP_DEVCONTAINER_USER_NAME:devuser}",
 			"USER_UID": "${localEnv:OTEL_CPP_DEVCONTAINER_USER_UID:1000}",
 			"USER_GID": "${localEnv:OTEL_CPP_DEVCONTAINER_USER_GID:1000}",
 			"INSTALL_PACKAGES": "${localEnv:OTEL_CPP_DEVCONTAINER_INSTALL_PACKAGES:}",
-			"CXX_STANDARD": "14",
-			"GRPC_VERSION": "v1.49.2",
-			"PROTOBUF_VERSION": "21.3",
-			"ABSEIL_CPP_VERSION":"20240116.1"
+			"CXX_STANDARD": "${localEnv:OTEL_CPP_DEVCONTAINER_CXX_STANDARD:17}",
+			"GRPC_VERSION": "${localEnv:OTEL_CPP_DEVCONTAINER_GRPC_VERSION:v1.55.0}",
+			"PROTOBUF_VERSION": "${localEnv:OTEL_CPP_DEVCONTAINER_PROTOBUF_VERSION:23.3}",
+			"ABSEIL_CPP_VERSION":"${localEnv:OTEL_CPP_DEVCONTAINER_ABSEIL_CPP_VERSION:20230125.3}"
 		}
 	},
 	"customizations": {
@@ -26,10 +25,10 @@
 				"ms-vscode.cpptools-extension-pack"
 			],
 			"settings": {
-				"terminal.integrated.shell.linux": "/bin/bash"
+				"terminal.integrated.shell.linux": "/bin/bash",
 			}
 		}
 	},
 
-	"remoteUser": "${env:USER_NAME}"
+	"remoteUser": "devuser"
 }

CONTRIBUTING.md

@@ -89,40 +89,8 @@ Before getting started, ensure you have the following installed:
    files provided (e.g., `.devcontainer/devcontainer.json`). This setup will install
    required dependencies, tools, and environment variables needed for the project.
 
-#### Customizing Your Dev Container
-
-Customize your dev container using build arguments (for direct Docker builds) or
-environment variables (for evaluation in `devcontainer.json`).
-
-* **Username:**
-  * Docker ARG:
-   `USER_NAME` (Default: `devuser`)
-  * Environment Variable:
-   `OTEL_CPP_DEVCONTAINER_USER_NAME` (Default: `devuser`)
-
-* **User ID (UID):**
-  * Docker ARG:
-   `USER_UID`  (Default: `1000`)
-  * Environment Variable:
-   `OTEL_CPP_DEVCONTAINER_USER_UID` (Default: `1000`)
-
-* **Group ID (GID):**
-  * Docker ARG:
-   `USER_GID`  (Default: `1000`)
-  * Environment Variable:
-   `OTEL_CPP_DEVCONTAINER_USER_GID` (Default: `1000`)
-
-* **Install Packages:**
-  * Docker ARG:
-   `INSTALL_PACKAGES`  (Default: ``)
-  * Environment Variable:
-   `OTEL_CPP_DEVCONTAINER_INSTALL_PACKAGES` (Default: ``)
-
-##### Examples
-
-* `docker build --build-arg USER_NAME=myuser --build-arg INSTALL_PACKAGES="nano gitk"...`
-* `export OTEL_CPP_DEVCONTAINER_USER_NAME=myuser`
-* `export OTEL_CPP_DEVCONTAINER_INSTALL_PACKAGES="nano gitk"`
+* **Container Customization**:
+   See `.devcontainer/README.md` for devcontainer configuration options.
 
 #### Available Commands
 
@@ -180,6 +148,30 @@ If you encounter issues:
 * **Bazelisk Documentation**: [https://github.com/bazelbuild/bazelisk](https://github.com/bazelbuild/bazelisk)
 * **VSCode DevContainer Documentation**: [https://code.visualstudio.com/docs/remote/containers](https://code.visualstudio.com/docs/remote/containers)
 
+### Docker Development Image
+
+To build a development docker image you can use `.devcontainer/Dockerfile.dev` dockerfile with the following command.
+
+```
+ docker build -t opentelemetry-cpp-dev -f ./.devcontainer/Dockerfile.dev .
+```
+
+You can customize the image using build arguments. Commonly you should set your user id and group id.
+
+```
+ docker build -t opentelemetry-cpp-dev \
+  --build-arg USER_UID="$(id -u)" \
+  --build-arg USER_GID="$(id -g)" \
+  -f ./.devcontainer/Dockerfile.dev .
+
+```
+
+Run an interactive bash session binding your host opentelemetry-cpp directory to the container:
+
+```
+docker run -it -v "$PWD:/workspaces/opentelemetry-cpp" opentelemetry-cpp-dev bash
+```
+
 ## Pull Requests
 
 ### How to Send Pull Requests