opensearch-project/OpenSearch

Docker is required to build

Open

#1,406 opened on Oct 21, 2021

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Java (1,505 forks)batch import
bughelp wanted

Repository metrics

Stars
 (8,123 stars)
PR merge metrics
 (Avg merge 5d 9h) (266 merged PRs in 30d)

Description

Is your feature request related to a problem? Please describe.

Coming from https://github.com/opensearch-project/OpenSearch/issues/1379, docker is required to build. But there seems to be code in place trying to say "if you don't have docker, that's ok, I'll just skip those parts". That doesn't work.

Describe the solution you'd like

Skip distribution:docker* if docker is not available.

Additional context

Docker (checked [/usr/bin/docker, /usr/local/bin/docker, C:\Program Files\Docker\Docker\resources\bin\docker.exe]) is required to run the following tasks:
:distribution:docker:buildArm64DockerImage
:distribution:docker:buildDockerImage
you can address this by attending to the reported issue, or removing the offending tasks from being executed.

To reproduce, return null from DockerSupportServices.java, private Optional<String> getDockerPath() or run on Windows.

Current workaround:

$ ./gradlew build -x ":distribution:docker:buildArm64DockerImage" -x ":distribution:docker:buildDockerImage"

Contributor guide

Research direction
Examine how Docker detection works in DockerSupportServices.java and modify the Gradle build script to conditionally skip Docker related tasks when Docker is not available.
Tech stack
java
Domain
build system
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJava
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70