Skip to content

Commit

Permalink
Updated readme for redboxoss docker repo
Browse files Browse the repository at this point in the history
  • Loading branch information
Lin Meyer authored and jvasallo committed Apr 19, 2020
1 parent 6711769 commit 8c36a3d
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
24 changes: 12 additions & 12 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -41,16 +41,16 @@ jobs:
tags: latest,${{ steps.get_version.outputs.VERSION }}
push: ${{ startsWith(github.ref, 'refs/tags/') }}
# On tag, Pack zip of scuttle for GitHub Release
# - name: Pack
# run: |
# mkdir build/artifacts
# zip -r -j build/artifacts/scuttle-linux-amd64.zip build/linux/amd64/
# if: startsWith(github.ref, 'refs/tags/')
- name: Pack
run: |
mkdir build/artifacts
zip -r -j build/artifacts/scuttle-linux-amd64.zip build/linux/amd64/
if: startsWith(github.ref, 'refs/tags/')
# On tag, Create GitHub Release
# - name: Release
# uses: softprops/action-gh-release@v1
# if: startsWith(github.ref, 'refs/tags/')
# with:
# files: build/artifacts/*.zip
# env:
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Release
uses: softprops/action-gh-release@v1
if: startsWith(github.ref, 'refs/tags/')
with:
files: build/artifacts/*.zip
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Scuttle

`scuttle` Is a wrapper application that makes it easy to run containers next to Istio sidecars. It ensures the main application doesn't start until envoy is ready, and that the istio sidecar shuts down when the application exists. This particularly useful for Jobs that need Istio sidecar injection, as the Istio pod would otherwise run indefinitely after the job is completed.
`scuttle` Is a wrapper application that makes it easy to run containers next to Istio sidecars. It ensures the main application doesn't start until envoy is ready, and that the istio sidecar shuts down when the application exits. This particularly useful for Jobs that need Istio sidecar injection, as the Istio pod would otherwise run indefinitely after the job is completed.

This application, if provided an `ENVOY_ADMIN_API` environment variable,
will poll indefinitely with backoff, waiting for envoy to report itself as live, implying it has loaded cluster configuration (for example from an ADS server). Only then will it execute the command provided as an argument.
Expand Down Expand Up @@ -50,7 +50,7 @@ To enable this, you must add `shareProcessNamespace: true` to your **Pod** defin
```dockerfile
FROM python:latest
# Below command makes scuttle available in path
COPY --from=jacobsvante/scuttle:latest /scuttle /bin/scuttle
COPY --from=redboxoss/scuttle:latest /scuttle /bin/scuttle
WORKDIR /app
COPY /app/ ./
ENTRYPOINT ["scuttle", "python", "-m", "my_app"]
Expand Down

0 comments on commit 8c36a3d

Please sign in to comment.