openshift/source-to-image
1
0
Fork 0
mirror of https://github.com/openshift/source-to-image.git synced 2026-02-05 12:44:54 +01:00
Code Issues Releases Activity

sti -> s2i rebranding

Browse Source
This commit is contained in:
Maciej Szulik
2015-07-24 18:39:35 +02:00
parent 29a97f4677
commit 20160b963a
16 changed files with 187 additions and 140 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/debugging-s2i.md
View File

@@ -4,22 +4,22 @@ Troubleshooting
This document contains some tips and suggestions for troubleshooting the use of source-to-image ("s2i") to build Docker images.
Can't Find The `sti` Executable
Can't Find The `s2i` Executable
--------------
Whether by running `make build` or `hack/build-release.sh`, look under the `_output/local/go/bin` directory.
If you have downloaded one of the official releases (see [releases](https://github.com/openshift/source-to-image/releases)), the `sti` executable is the only file in the tar archive.
If you have downloaded one of the official releases (see [releases](https://github.com/openshift/source-to-image/releases)), the `s2i` executable is the only file in the tar archive.
Security And Docker
--------------
As noted [here](https://github.com/openshift/source-to-image/#security), there are considerations to allow S2I to interact with Docker, including possibly running `sudo sti`.
As noted [here](https://github.com/openshift/source-to-image/#security), there are considerations to allow S2I to interact with Docker, including possibly running `sudo s2i`.
Image Mechanics
--------------
By default, s2i will always pull the image from the remote Docker repository rather than using the local builder image if available on the host from which you are running the `sti` command. However, if for performance reasons you choose to leverage the `--force-pull=false` option when running the `sti` command,
By default, s2i will always pull the image from the remote Docker repository rather than using the local builder image if available on the host from which you are running the `s2i` command. However, if for performance reasons you choose to leverage the `--force-pull=false` option when running the `s2i` command,
you must guard against the local builder image becoming stale and out of date.
Permissions Needed During the S2I Process
@@ -29,14 +29,14 @@ The s2i process will leverage the `/tmp` directory at various stages, such as wh
E0720 21:07:17.145257 04202 main.go:328] An error occurred: creating temporary directory failed
Hence, the user ID you execute the `sti` command with must have the appropriate permission to read, create, and remove files under `/tmp`.
Hence, the user ID you execute the `s2i` command with must have the appropriate permission to read, create, and remove files under `/tmp`.
Passing In Environment Variables
--------------
If you are passing in environment variables with the -e option from the command line, and those environment variables have values with commas in them, Go command line processing will break.
$ ~/sandbox/ruby sti build --loglevel=5 -e "MAVEN_ARGS='-P some-repo,some-other-repo'" file:///home/mfojtik/sandbox/ruby openshift/ruby-20-centos7 foo
$ s2i build --loglevel=5 -e "MAVEN_ARGS='-P some-repo,some-other-repo'" file:///home/mfojtik/sandbox/ruby openshift/ruby-20-centos7 foo
I0519 14:20:51.410089 17228 util.go:34] Using my@cred.sk credentials for pulling openshift/ruby-20-centos7
I0519 14:20:51.410222 17228 main.go:239] An error occurred: malformed env string: some-other-repo'
@@ -70,8 +70,8 @@ Review the example [here](https://github.com/gabemontero/source-to-image/blob/ma
####Dowloading / Finding The Scripts
Per this discussion point [here](https://github.com/openshift/source-to-image/blob/master/docs/builder_image.md#sti-scripts), if your s2i related scripts are already placed in the image, but their locations are not indicated by one of the provided means, attempts to download the scripts will fail.
Per this discussion point [here](https://github.com/openshift/source-to-image/blob/master/docs/builder_image.md#s2i-scripts), if your s2i related scripts are already placed in the image, but their locations are not indicated by one of the provided means, attempts to download the scripts will fail.
E0720 21:08:37.166063 04204 main.go:328] An error ocurred: scripts inside the image: image:///path/to/image
@@ -101,7 +101,7 @@ If you find yourself still stuck, before seeking help in #openshift on freenode.
1. s2i logs at level 5 (verbose logging):
$ sti < other options > --loglevel=5 &> /tmp/sti.log
$ s2i < other options > --loglevel=5 &> /tmp/s2i.log
2. Container logs
@@ -111,7 +111,7 @@ If you find yourself still stuck, before seeking help in #openshift on freenode.
docker logs $container >& $LOG_DIR/container-$container.log
done
3. By default, the working directory under `/tmp` is removed when the `sti` command completes. The `--save-temp-dir=true` option will preserve the working directory under `/tmp`. Those files can often provide useful diagnostics.
3. By default, the working directory under `/tmp` is removed when the `s2i` command completes. The `--save-temp-dir=true` option will preserve the working directory under `/tmp`. Those files can often provide useful diagnostics.
@@ -119,4 +119,4 @@ Debugging Integration Test Failures
--------------
For diagnosing failures when running hack/test-integration.sh, passing the -v option to the hack/test-integration.sh script will not only turn on verbose bash tracing, but will set --loglevel=5 tracing for the S2I internals, in
order to provide additional details that can help diagnose issues.
order to provide additional details that can help diagnose issues.