Skip to content

replace yaml-merge with yq, fix quickstart deployment docs. Closes #1780 #1782

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brollb merged 5 commits into from
Jul 20, 2020
Merged

replace yaml-merge with yq, fix quickstart deployment docs. Closes #1780 #1782

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
cb5505a
replace yaml-merge with yq, fix quickstart deployment docs. Closes #1780
umesh-timalsina Jul 17, 2020
16e3d83
WIP- rephrase production-docker-compose.yml creation sentence
umesh-timalsina Jul 17, 2020
42b7d3d
Minor changes to quickstart docs, docker-compose, deploy-deepforge
umesh-timalsina Jul 17, 2020
8c853b9
WIP- remove NODE_ENV=production quickstrat docs
umesh-timalsina Jul 17, 2020
24c656f
WIP remove -e from docker quickstart tutorial
umesh-timalsina Jul 17, 2020
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
2 changes: 1 addition & 1 deletion .deployment/deploy-deepforge
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ fi;
rm config/components2.json

# Merging the custom override yml file
yaml-merge docker/docker-compose.yml "$DEEPFORGE_DEPLOYMENT_DIR"/docker-compose-overrides.yml > custom-docker-compose.yml
yq m -a docker/docker-compose.yml "$DEEPFORGE_DEPLOYMENT_DIR"/docker-compose-overrides.yml > custom-docker-compose.yml

# Pulling the latest docker image, stopping the server, removing and restarting it
docker-compose --file custom-docker-compose.yml -p deepforge pull $SERVER_NAME
Expand Down
2 changes: 0 additions & 2 deletions .deployment/docker-compose-overrides.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ services:
- "DEEPFORGE_HOST=https://dev.deepforge.org"
- "DEEPFORGE_INTERACTIVE_COMPUTE_HOST=https://dev-compute.deepforge.org"
volumes:
- "$HOME/.deepforge/blob:/data/blob"
- "${TOKEN_KEYS_DIR}:/token_keys"
- "${DEEPFORGE_DEPLOYMENT_DIR}:/.deployment"
- "${DEEPFORGE_DEPLOYMENT_DIR}/../config/components.json:/deepforge/config/components.json"

Expand Down
20 changes: 4 additions & 16 deletions docs/deployment/quick_start.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,11 @@ Next, you must decide if you would like authentication to be enabled. For produc

Without User Accounts
---------------------
Open the docker-compose file and add the following environment variable to the server:
Start the docker containers with ``docker-compose run`` :

.. code-block:: bash

NODE_ENV=default

and delete the volume for the server's keys (used for signing JWTs):

.. code-block:: bash

- "${TOKEN_KEYS_DIR}:/token_keys"

Next, start the docker containers with

.. code-block:: bash

docker-compose up
docker-compose --file docker-compose.yml run -p 8888:8888 -p 8889:8889 -e "NODE_ENV=default" server

User Authentication Enabled
---------------------------
Expand All @@ -41,11 +29,11 @@ First, generate a public and private key pair
openssl rsa -in deepforge_keys/private_key -pubout > deepforge_keys/public_key
export TOKEN_KEYS_DIR="$(pwd)/deepforge_keys"

Then start DeepForge using docker-compose:
Then start DeepForge using ``docker-compose run``:

.. code-block:: bash

docker-compose up
docker-compose --file docker-compose.yml run -v "${TOKEN_KEYS_DIR}:/token_keys" -p 8888:8888 -p 8889:8889 server

Finally, create the admin user by connecting to the server's docker container. First, get the ID of the container using:

Expand Down