How to Build an Example Vultr Marketplace Application

1. Edit your vendor settings.

2. Create a new application profile.

3. Edit the general information.

4. Edit the support information.

1. For the sample application in this guide create the variables db_pass and web_pass.

   

   Follow the Create Application Variables-create-application-variables) section in our Vultr Marketplace guide for more details.

2. Next, publish the instructions for the customer deployment page and include your application variables. Follow the Create the Application Instructions section in our Vultr Marketplace guide for more details.

3. Add your application's gallery images. Follow the Upload Artwork section in the Vultr Marketplace guide. Your public landing page uses these images to showcase your application.

1. Clone the vultr-marketplace GitHub Repository.

   console Copy

   $ git clone https://github.com/vultr/vultr-marketplace.git
   

2. Install HashiCorp Packer.

3. Verify your workstation's IP address is in your Vultr API access control list.

4. Create an environment variable for Vultr API key.

   console Copy

   $ export VULTR_API_KEY=<vultr-api-key>
   

5. To have a debug log, export the two variables below.

   console Copy

   $ export PACKER_LOG=1
   $ export PACKER_LOG_PATH=packer.log
   

6. Switch to the sample-app directory.

   console Copy

   $ cd vultr-marketplace/sample-app
   

7. Download the Vultr Packer plugin.

   console Copy

   $ packer init sample-app.pkr.hcl
   

8. Use packer build to automatically deploy a server, prepare it, make a snapshot, and then destroy the original server.

   console Copy

   $ packer build sample-app.pkr.hcl
   

   Packer will create a snapshot in your Vultr account named Sample App <Date Time>.

9. Assign the created snapshot as the live image. Follow the Build App Image section in our Vultr Marketplace guide for more details.

Provisioning Scripts

The example app in this guide uses two provisioning scripts.

Per-Instance Scripts

Packer installs a deployment script in the snapshot at /var/lib/cloud/scripts/per-instance/setup-per-instance.sh. You can see the script in GitHub here.

The script executes when the customer deploys the server. It is only executed once and will not be re-executed when rebooting a server. Below are the procedures happening each time a new server with the script is deployed.

• The script logs the start date/time to /var/log/per-instance.log.
• It captures the marketplace variables db_pass and web_pass.
• It creates a database.
• It also adds example_user to the database with the db_pass password.
• Creates an Nginx password for example_user with the web_pass password.
• At the end, it logs the end date/time to /var/log/per-instance.log.

The lines that capture the Marketplace Password variables use curl to retrieve variables that will be defined in later steps of this guide. The URL endpoint names are based on the variable names you defined earlier in the format:

http://<server-ip>/v1/internal/app-{variable_name}

Follow the Create Provisioning Scripts section in our Vultr Marketplace guide for more details.

Per-Boot Script

Packer also installs a per-boot deployment script in the snapshot at /var/lib/cloud/scripts/per-boot/setup-per-boot.sh. You can see the script in GitHub here

The script executes on every boot of the server. When the script runs, it logs the date/time to /var/log/per-boot.log. You can modify this script as needed.

More About Provisioning Scripts

You can run other types of provisioning scripts in addition to these examples. Visit the cloud-init documentation for more information.

1. Deploy your Marketplace application from the Marketplace Builds tab. Use the Deploy Image option.

   

2. You'll be directed to the server deployment page of the Vultr customer portal, and your Marketplace image is automatically selected as the Server Type.

3. Once the application is deployed, access your instance using the root password provided on the server information page.

4. Check the cloud-init provision script log. You should see entries with a recent date and time.

   console Copy

   $ cat  /var/log/per-instance.log
   

5. Verify the existence of the Nginx password file and the password hash created by the provisioning script.

   console Copy

   $ cat /etc/nginx/.htpasswd
   

6. Look up the website password on the server information page. Alternatively, you can also find the password in the /root/web-password.txt file.

7. Navigate to the website. The website will prompt you for a username and password. Enter the username example_user and the password shown on the server information page.

8. Log into the database as example_user with the database password shown on the server information page. Alternatively, you can also find the password in the /root/db-password.txt file.

   console Copy

   $ mysql -u example_user -p
   

9. Show the database list and confirm the existence of example_db.