GenAIExamples icon indicating copy to clipboard operation
GenAIExamples copied to clipboard

Docker proxy settings

Open eero-t opened this issue 1 year ago • 5 comments
trafficstars

Many docs in this repo instruct giving HTTP/S proxies on Docker build command line:

$ git grep -e "--build-arg.*https*_proxy=" | wc -l
58

IMHO it would be better to just specify them once in Docker config, like this:

$ cat ~/.docker/config.json`
...
	"proxies": {
		"default": {
			"httpProxy": "http://proxy-chain.foobar.com:911",
			"httpsProxy": "http://proxy-chain.foobar.com:911",
			"noProxy": "localhost,127.0.0.1/8,::1,192.168.0.0/16,10.244.0.0/16"
		}
	}
}

eero-t avatar May 29 '24 13:05 eero-t

@eero-t Thanks for the suggestion, we'll get back to you soon.

devpramod avatar Jun 19 '24 00:06 devpramod

Thanks, we will check it. We have some discussion before

kevinintel avatar Jul 03 '24 08:07 kevinintel

if could, please provide a PR for ReadME and describe the step. Thanks

kevinintel avatar Jul 09 '24 07:07 kevinintel

if could, please provide a PR for ReadME and describe the step. Thanks

Sorry, that things is in so many files [1] that cleaning it is way too large task for me. While fixing the READMEs might still be doable (and IMHO much improves their readability), fixing the shell scripts and testing them with updated docker config definitely is not.

Proxy setting can be removed from all the Docker command lines, and READMEs can instead can link a common README telling how to setup build environment ("Pre-conditions: suitable Docker proxy setup, see link").

Proxy setup section for such a build env setup README, could look like this:


In corporate environment Internet access often needs to go through proxies. Because Docker builds are run under separate daemon in the host system, proxy setting may need to be specified for Docker separately.

Proxies are set in Docker configuration like this:

$ cat ~/.docker/config.json
...
	"proxies": {
		"default": {
			"httpProxy": "http://proxy-chain.my-company.com:911",
			"httpsProxy": "http://proxy-chain.my-company.com:911",
			"noProxy": "localhost,127.0.0.1/8,::1,192.168.0.0/16"
		}
	}
}

[1] Both READMEs and shell scripts.

Both in GenAIComps repo files:

$ git grep -il "docker.*build.*proxy" 
comps/asr/README.md
comps/dataprep/milvus/README.md
comps/dataprep/pgvector/README.md
comps/dataprep/pinecone/README.md
comps/dataprep/qdrant/README.md
comps/dataprep/redis/README.md
comps/embeddings/README.md
comps/embeddings/langchain-mosec/README.md
comps/guardrails/README.md
comps/guardrails/pii_detection/README.md
comps/llms/README.md
comps/llms/text-generation/ollama/README.md
comps/llms/text-generation/tgi/README.md
comps/llms/text-generation/tgi/build_docker.sh
comps/llms/text-generation/vllm-openvino/build_vllm_openvino.sh
comps/llms/text-generation/vllm-xft/README.md
comps/llms/text-generation/vllm/build_docker_vllm.sh
comps/lvms/README.md
comps/ragas/tgi/build_docker.sh
comps/reranks/README.md
comps/reranks/fastrag/README.md
comps/reranks/langchain-mosec/README.md
comps/retrievers/langchain/milvus/README.md
comps/retrievers/langchain/pgvector/README.md
comps/retrievers/langchain/redis/README.md
comps/tts/README.md
comps/web_retrievers/langchain/chroma/README.md
tests/test_dataprep_pgvector.sh
tests/test_dataprep_redis_langchain.sh
tests/test_dataprep_redis_langchain_ray.sh
tests/test_dataprep_redis_llama_index.sh
tests/test_embeddings_langchain-mosec.sh
tests/test_embeddings_llama_index.sh
tests/test_guardrails_pii_detection.sh
tests/test_llms_summarization_tgi.sh
tests/test_reranks_fastrag.sh
tests/test_reranks_langchain-mosec.sh
tests/test_retrievers_langchain_pgvector.sh
tests/test_retrievers_langchain_redis.sh
tests/test_vectorstores_pgvector.sh
tests/test_web_retrievers_langchain.sh

And in GenAIExamples repo files:

$ git grep -il "docker.*build.*proxy"
.github/workflows/scripts/build_push.sh
AudioQnA/deprecated/README.md
AudioQnA/deprecated/serving/tgi_gaudi/build_docker.sh
AudioQnA/deprecated/tests/test_asr.sh
AudioQnA/deprecated/tests/test_tts.sh
AudioQnA/docker/gaudi/README.md
AudioQnA/docker/xeon/README.md
ChatQnA/deprecated/serving/tgi_gaudi/build_docker.sh
ChatQnA/docker/gaudi/README.md
ChatQnA/docker/gpu/README.md
ChatQnA/docker/xeon/README.md
CodeGen/deprecated/codegen/build_docker.sh
CodeGen/deprecated/serving/tgi_gaudi/build_docker.sh
CodeGen/docker/gaudi/README.md
CodeGen/docker/xeon/README.md
CodeTrans/deprecated/langchain/docker/build_docker.sh
CodeTrans/deprecated/serving/tgi_gaudi/build_docker.sh
CodeTrans/docker/gaudi/README.md
CodeTrans/docker/xeon/README.md
DocSum/deprecated/langchain/docker/build_docker.sh
DocSum/deprecated/serving/tgi_gaudi/build_docker.sh
DocSum/docker/gaudi/README.md
DocSum/docker/xeon/README.md
DocSum/tests/test_docsum_on_gaudi.sh
DocSum/tests/test_docsum_on_xeon.sh
SearchQnA/deprecated/README.md
SearchQnA/deprecated/serving/tgi_gaudi/build_docker.sh
SearchQnA/deprecated/tests/test_langchain_inference.sh
SearchQnA/docker/gaudi/README.md
SearchQnA/docker/xeon/README.md
Translation/deprecated/langchain/docker/build_docker.sh
Translation/deprecated/serving/tgi_gaudi/build_docker.sh
Translation/deprecated/tests/test_langchain_inference.sh
Translation/docker/gaudi/README.md
Translation/docker/xeon/README.md
Translation/tests/test_translation_on_gaudi.sh
VisualQnA/README.md
VisualQnA/tests/test_basic_inference.sh

eero-t avatar Jul 09 '24 09:07 eero-t

@devpramod, @eero-t, We will add a description of the Docker configuration settings in the README. Users can choose to either change the Docker configuration or pass proxy environment variables. We will retain the proxy environment variable settings. If users only change the Docker configuration and do not pass the proxy environment variables, it will not affect anything.

lvliang-intel avatar Jul 30 '24 14:07 lvliang-intel

Looks like this can be closed as not planned / won't fix?

dcmiddle avatar Sep 13 '24 17:09 dcmiddle