Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions ci/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,22 @@ x-envoy-build-base: &envoy-build-base
- ENVOY_HEAD_REF
- ENVOY_OUTPUT_BASE_DIR
- ENVOY_REPO
- ENVOY_REGISTRY_HASH
- ENVOY_REGISTRY_ALLOW_UNSAFE
- ENVOY_BUILD_ARCH
- ENVOY_GEN_COMPDB_OPTIONS

# Publishing and artifacts
- ENVOY_DOCKER_SAVE_IMAGE
- ENVOY_PUBLISH_DRY_RUN
- ENVOY_TARBALL_DIR
- DOCS_BUILD_RELEASE
- BUILD_DOCS_TAG
- BUILD_DOCS_SHA

# Release signing
- ENVOY_SIGNING_KEY_PATH
- ENVOY_SIGNING_PASSPHRASE_PATH

- MOBILE_DOCS_CHECKOUT_DIR
- SYSTEM_STAGEDISPLAYNAME
Expand Down Expand Up @@ -117,19 +126,13 @@ services:
- ${SOURCE_DIR:-..}:/source${MOUNT_ACCESS_MODE:-}
- ${SHARED_TMP_DIR:-/tmp/bazel-shared}:${SHARED_TMP_DIR:-/tmp/bazel-shared}${MOUNT_ACCESS_MODE:-}

envoy-build-gpg:
<<: *envoy-build-base
volumes:
- ${ENVOY_DOCKER_BUILD_DIR:-/tmp/envoy-docker-build}:/build
- ${SOURCE_DIR:-..}:/source
- ${ENVOY_GPG_DIR-${HOME}/.gnupg}:/build/.gnupg
- ${SHARED_TMP_DIR:-/tmp/bazel-shared}:${SHARED_TMP_DIR:-/tmp/bazel-shared}

envoy-build-dind:
privileged: true
<<: *envoy-build-base
volumes:
- ${ENVOY_DOCKER_BUILD_DIR:-/tmp/envoy-docker-build}:/build
- ${SOURCE_DIR:-..}:/source
- /var/run/docker.sock:/var/run/docker.sock
- ${SHARED_TMP_DIR:-/tmp/bazel-shared}:${SHARED_TMP_DIR:-/tmp/bazel-shared} - ${ENVOY_ENTRYPOINT_EXTRA:-./docker-entrypoint-extra.sh}:/entrypoint-extra.sh
- ${SHARED_TMP_DIR:-/tmp/bazel-shared}:${SHARED_TMP_DIR:-/tmp/bazel-shared}
# Nighthawk inlines docker.sock GID setup above and does not have docker-entrypoint-extra.sh # unique
# - ${ENVOY_ENTRYPOINT_EXTRA:-./docker-entrypoint-extra.sh}:/entrypoint-extra.sh # unique
25 changes: 19 additions & 6 deletions docs/root/updating_envoy_dependency.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ cp -v "$envoy_dir/ci/run_envoy_docker.sh" "ci/run_envoy_docker.sh"

### Step 9

Set up a Bash function `merge_from_envoy` that will be used repeatedly in the example commands in steps 10-13.
Set up a Bash function `merge_from_envoy` that will be used repeatedly in the example commands in steps 10-14.

Paste the following into the shell:

Expand Down Expand Up @@ -282,6 +282,19 @@ merge_from_envoy "tools/code_format/config.yaml"

### Step 14

Sync (copy) [ci/docker-compose.yml](/ci/docker-compose.yml) from
[Envoy's version](https://github.com/envoyproxy/envoy/blob/main/ci/docker-compose.yml) to
update our Docker build container configuration. Be sure to retain our local modifications,
all lines that are unique to Nighthawk are marked with comment `# unique`.

#### Example commands

```bash
merge_from_envoy "ci/docker-compose.yml"
```

### Step 15

The Python dependencies need to be updated regularly. The list of packages
the Nighthawk codebase uses is listed in
[tools/base/requirements.in](/tools/base/requirements.in). This file specifies
Expand All @@ -301,7 +314,7 @@ This will use the configuration from
[tools/base/requirements.in](/tools/base/requirements.in) and update the lock
file [tools/base/requirements.txt](/tools/base/requirements.txt).

### Step 15
### Step 16

Run:

Expand All @@ -327,13 +340,13 @@ See [Troubleshooting](#troubleshooting) for tips.

If you removed any pins or updated Python dependencies in the previous step, you
may see new failures due to these updates. Re-introduce dependency pins as necessary and execute the update
command Step 14 again. Repeat this until the tests pass and document the need for any
command Step 15 again. Repeat this until the tests pass and document the need for any
pins in [tools/base/requirements.in](/tools/base/requirements.in).

If you updated the Python dependencies, update the date at the top of the
[tools/base/requirements.in](/tools/base/requirements.in) file.

### Step 16
### Step 17

If the PR ends up modifying any C++ files, execute:

Expand All @@ -351,7 +364,7 @@ rm -rf tools/pyformat/

and retrying the format command.

### Step 17
### Step 18

If Nighthawk command line flags have been changed, execute:

Expand All @@ -363,7 +376,7 @@ to regenerate the
portion of our documentation that captures the CLI help output. This will
prevent a CI failure in case any flags changed in the PR or upstream.

### Step 18
### Step 19

Create a PR with a title like `Update Envoy to 9753819 (Jan 24th 2021)`,
describe all performed changes in the PR's description ([example PR
Expand Down
Loading