Deploying and Managing Instances
In this article:
- Deploying a new instance
- Creating a deployment profile
- Scheduling Instances
- Handling instance lifecycle states
Deploying a New Instance
An instance is an instantiated version of a box launched to provider’s virtual infrastructure or your own. Follow these steps to launch one.
- Click Instances > New Instance
Select a box. You can search and look through the tabs.
- My Boxes. Shows boxes you created in your workspace.
- Shared with Me. Shows boxes others shared with you.
Quick Starts. Shows default boxes available to all Cloud Application Manager users. These include service boxes such as Linux Compute and Windows Compute.
Note: Don’t find a box you’re looking for? Check if you’re in the right workspace. Remember that you may not have access if the box is no longer shared with you.
In the New Instance dialog, specify the environment name and deployment profile.
Environment. Give a name to recognize the instance.
Deployment Profile. Select a previously created deployment profile or create a new one. For details, see Creating a Deployment Profile.
In the New Instance dialog, pass deployment parameters under Variables. Before launching, you can override and provide fresh values.
- Listed here are all the variables defined in the main box as well as those within nested boxes or box type variables.
- Required variables are marked with an asterisk. To see all variables including optional ones, click Show More.
- When a variable is required, you must specify its value to launch an instance of the box. If optional, you can launch without giving values, and do it later in the lifecycle editor.
- Binding type variables are also listed here. Depending on how it’s defined in the box, you can select as its value any instance or that of a specific box type deploying or active in the workspace.
Creating a Deployment Profile
A deployment profile defines settings for your infrastructure that are applied at deployment time. These settings include the cloud provider that will host the deployed boxes, how the virtual infrastructure will be sized, and where it will be placed.
In the New Instance dialog, click New Profile.
Enter a profile name. Typically deployment profiles are named for the stage in the application lifecycle they represent, such as Dev, Test, QA, Pre-Production, and Production. However you could also use them to represent geographical or logical environments.
Configure the deployment profile settings for the box you selected from the catalog.
Settings in the deployment profile vary by the provider you deploy to. For provider specific deployment settings, see these articles:
- Using CenturyLink Cloud
- Using Google Cloud
- Using Your AWS Account
- Using the vSphere Private Datacenter
- Using Your OpenStack Cloud
- Using CloudStack
Note: If you’re deploying to public cloud providers like AWS or Google Compute, you’ll most likely be charged by the cloud provider for the virtual infrastructure you provision. Familiarize yourself with their pricing model as Cloud Application Manager assumes no responsibility for costs incurred.
Save on compute and hosting costs by scheduling instances at launch time. Rather than remember to turn off a machine manually, schedule it to stop automatically at your convenience. When launching, you can schedule an instance to shut down or terminate at a given UTC time.
We notify you of instances about to expire in 24 hours by email at around 12 AM UTC. From the email, you can navigate to the instance page and change the schedule if you like. If you don’t get this email, check your email spam filters or check if SMTP outbound is on in the setup console for the Cloud Application Manager appliance.
Follow these steps to schedule an instance.
- From the Instances page, click New Instance.
- Select a box you want to deploy.
In the New Instance dialog, select the Shutdown or Terminate operation from the Expiration drop-down. Select Always on if you don’t want to schedule anything. Shutdown powers off the instance while Terminate deletes the instance on the provider’s side.
For the selected operation, set a predefined or custom UTC schedule.
When done, click Deploy.
Note: Even if you don’t schedule an instance at the time of deploying, you can do so later. Once online, you can go to an instance page and in Edit Details, set the schedule.
Besides the user interface, you can automatically schedule instances using the instances API with a POST ot PUT request.
Handling Instance Lifecycle States
Instance actions (on the instances page or the lifecycle editor) trigger deployment related event scripts from your box. Take these actions to start, stop, terminate an instance, and even perform upgrades or make changes to your live instance.
Some actions are available only after the instance changes state. For example, you can’t forcibly terminate an instance until you’ve terminated it first.
Go to the Admin Console to manage several instances spread across users and workspaces in your organization.
This executes the configure events from the box.
This re-runs the install scripts from your boxes onto the existing virtual infrastructure. This is useful if you made changes to your scripts within this instance, say to upgrade the instance to a new box version. A reconfigure automatically follows the reinstall.
This virtually powers on your instance. It’s useful in case you’ve shut the instance down. After powering on, the configure and start scripts from the box execute.
This runs the stop scripts from your box instance and cleanly shuts down the OS. It’s useful if your instance does not need to be up 24/7. As some cloud providers only charge for running instances, this can save money.
This executes the dispose scripts from your box instance and then deletes the virtual infrastructure. You can’t revert the action and since you can lose data, be sure that you want to perform this action in the first place.
If a Terminate fails for some reason (maybe a broken dispose script) then this forcibly deletes the virtual infrastructure. If you previously terminated or deleted an instance from the provider’s side, the instance may linger in Force Terminate in Cloud Application Manager. Give it a couple of minutes then try to force-terminate again.
Click the delete icon after you Terminate or Force Terminate an instance. Until then, the box instance page and logs are retained in the Cloud Application Manager database. But delete completely removes the box instance page.
Contacting Cloud Application Manager Support
For issues related to API calls, send the request body along with details related to the issue.
In the case of a box error, share the box in the workspace that your organization and Cloud Application Manager can access and attach the logs.
- Linux: SSH and locate the log at /var/log/elasticbox/elasticbox-agent.log
- Windows: RDP into the instance to locate the log at ProgramDataElasticBoxLogselasticbox-agent.log