-
Notifications
You must be signed in to change notification settings - Fork 4
Effects on your local machine
Ahmed Jazzar edited this page Oct 24, 2019
·
1 revision
Some of the commands we run here might edit some files, or change the state of some programs on your machine. To keep those effects clear, we documented them here by affected modules.
-
/etc/hosts
: Failure to update this file with the correct values will prevent you from accessing the devstack on your remote machine. This file will be automatically updated every time you:- Start an instance. (
instance.start
) - Stop an instance. (
instance.stop
) - Delete an instance. (
instance.delete
) - Setting up an instance. (
instance.setup
orinstance.setup.image
)
- Start an instance. (
-
~/.ssh/config
: Failure to update this file will prevent the toolkit from having an appropriate connection with the remote machine. This file will be automatically updated every time you:- Start an instance. (
instance.start
) - Setting up an instance. (
instance.setup
orinstance.setup.image
)
- Start an instance. (
-
~/.ssh/known_hosts
: Failure to update this file will complicate the process of connecting to your remote machine using SSH and will require you to manually keep editing the file. To make this easier on you, this file will be automatically updated every time you:- Start an instance. (
instance.start
) - Setting up an instance. (
instance.setup
orinstance.setup.image
)
- Start an instance. (
-
ssh-agent
: Failure to add your$SSH_KEY
to you thessh-agent
will prevent your remote machine from accessing private repos on your github account and will require you to manually setup private keys on the machine. We will make sure that the record exists every time you:- Start an instance. (
instance.start
) - Setting up an instance. (
instance.setup
orinstance.setup.image
)
- Start an instance. (
-
TMP_DIR
: A new directory will be created for you in the place you define in your.env
file. This directory will hold the mounts and and any other required data we need to keep track of. An interaction with this directory will happen every time you:- Mount your devstack. (
devstack.mount
) - Unmount your devstack. (
devstack.unmount
)
- Mount your devstack. (
Sultan v1.1.0
An Open edX Remote Devstack Toolkit by Appsembler
Errors are possible all the time. If an error's fired while executing commands from this toolkit it is recommended to do a little bit more debugging. While this might be an issue with the tool, we just want you to make sure that have everything correct set up in place:
- Run make
config.debug
and check if all of your environment variables hold the correct values. - Toggle the verbosity settings (
VERBOSITY
, andSHELL_OUTPUT
) in your env file. Follow instructions in the comments above of them for more details. - Check our Wiki page for a detailed documentation on the configuration process.
If you couldn't identify the cause of the problem, please submit an issue on https://github.com/appsembler/sultan/issues.