Skip to content

Commit

Permalink
Added docs for deploy_info
Browse files Browse the repository at this point in the history
Signed-off-by: aryans1204 <arshar1204@gmail.com>
  • Loading branch information
aryans1204 committed Feb 19, 2025
1 parent 034ebc5 commit 93792a1
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/generate_deploy_info_docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Deploy Info JSON

## The `deploy_info.json` file in the `yamls.tar.gz` is used to identify the relative filepaths for the Knative YAML manifests for deploying vSwarm functions. It is generated using `generate_deploy_info.py` Python script, also present under `yamls.tar.gz`, which outputs a JSON that embeds the yaml-location and predeployment-commands for every vSwarm function.

## While the `deploy_info.json` file ships with the `yamls.tar.gz`, In order to regenerate the `deploy_info.json` run:
```console
tar -xzvf workloads/container/yamls.tar.gz -C workloads/container
cd workloads/container/yamls/
python3 generate_deploy_info.py
```

0 comments on commit 93792a1

Please sign in to comment.