CLI Tutorial: VCS Project Deployment

Deployment via VCS is a rather popular and convenient way for project’s integration into the Cloud, as it simplifies operating with app’s sources and allows to easily update its version (either manually or automatically with a certain interval). And the variety of options, available for the VCS deployment management via CLI, gives you the full control on your app.

1. For example, in order to create a new project, the following command should be run:

~/jelastic/environment/vcs/createproject --envName  {env_name} --type  {type} --context  {context} --url  {url} [--branch  {branch}] --autoupdate {true/false} [--interval  {interval}] --autoResolveConflict {true/false} --zdt {true/false}

Here, the list of parameters can be divided into the following groups:

  • main configurations
    • {env_name} - name of your environment
    • {type} - VCS type, either git or svn; in the first case, the additional {branch} parameter is needed to point to the corresponding projects' version
    • {context} - context name for a new project
    • {url} - link to the appropriate repository
  • additional options (their activation is defined with the {true/false} values)
    • autoupdate - enables regular autoupdate of your deployed project; if activated, requires the additional {interval} parameter for setting the frequency of redeployments
    • autoResolveConflict - switches on the corresponding same-named option
    • zdt - allows to activate ZDT deployment for PHP projects

Note: In case you need to connect to a private repository, the additional authentication parameters [–login {login}] [–password {password}] [–keyId {keyId}] should be added to the main command. Here, you need to obligatory state the {login} option (to specify your VCS account login) and append one of the following settings depending on the desired (password or SSH key) access types:

  • {password} - the corresponding VCS account password
  • {keyId} - name of the private SSH key you’ve specified while its addition to the dashboard; this allows to establish a secure connection to the repo with the paired public SSH key is attached
CLI create VCS project After executing, you’ll be shown a brief info on the created project within the received response.
Tip: The above described command correspond to the Add project dashboard frame’s functionality, so in case you return to the GUI panel and click the Edit button next to the newly appeared project, you’ll see all the appropriate options applied within its settings. If the project is not displayed, just refresh the page with your dashboard.

2. The next step is running the update command in order to apply these settings and, actually, deploy your project.

~/jelastic/environment/vcs/update  --envName  {env_name} --context  {context}

Set the same parameters' values as in the previous step. CLI update VCS project Subsequently, this command can be also used for manual redeployment of your app based on the updated VCS sources.

3. In case you need to edit project settings (e.g. to switch the version branch), the editproject method should be executed:

~/jelastic/environment/vcs/editproject --envName  {env_name} --type  {type} --oldcontext  {oldcontext} --newcontext  {newcontext} --url  {url} [--branch  {branch}] --autoupdate {true/false} [--interval  {interval}] --autoResolveConflict {true/false} --zdt {true/false}

The majority of parameters are already familiar for you, except the following ones that have substituted the previously used {project} property:

  • {oldcontext} - name of the project (i.e. context) that should be changed
  • {newcontext} - new context for the project (it’s obligatory for specifying; however, could be stated the same as {oldcontext})

The rest of options' values can be changed based on your needs.

CLI edit VCS project

Note: This command just updates the corresponding project’s settings, while for their appliance the update method should be called (we’ve considered it in the 2nd step).
That’s all! Now you can create and manage your own VCS projects at the platform right through your terminal.

What’s next?

For more usage examples refer to the following documents: