Customizing Deployments

Using Assets in the YAML file

Avatar

squashlabs, April 12, 2019

When the Assets Storage is enabled Squash will automatically add a new /assets/ mount point for all deployments within the repository. Using the copy_files_build_process feature in the YAML file Here you would manually copy files or folders within the build process defined in the .squash.yml file. This will essentially transfer data from the assets folder to a different location within

Read more

Deployment Cache

Avatar

squashlabs, April 12, 2019

The Deployment Cache (DC) is a good way to speed up the build process of deployments. This feature is enabled by default on all repositories. Squash generates a cache snapshot for the following types of apps, across all branches in a repository: A Squash YAML file, in case you are not using Docker Each unique

Read more

Customizing PR Comments

Avatar

squashlabs, April 12, 2019

You can customize a Squash PR comment to list different applications, subdomains and URL arguments. You may also restrict the visibility of this automatic comment based on changes in certain folders (see below). Listing Multiple Applications See this page for more details on repos with multiple applications. Listing Subdomains Squash has built-in support for subdomains

Read more

Subdomain port mapping

Avatar

squashlabs, April 12, 2019

For reference, here is how Squash handles subdomains and multi-level subdomains. Subdomain port mapping is a great way to define HTTP endpoints for microservices to facilitate the communication between apps and APIs. This feature works for Dockerfiles, docker-compose and any apps without Docker. Example using Docker For this example we will use a repository with

Read more

VM Sizes

Avatar

squashlabs, April 12, 2019

Available VM sizes Click here for a complete list of the available VM types, including memory, storage and CPU. Changing VM sizes You can configure the right amount of memory, vCPU and storage to tailor your needs. Every application is different and Squash gives you flexibility to change these settings in multiple levels. Account Level

Read more

Account & Permissions

Avatar

squashlabs, April 2, 2019

Squash.io: One-click preview environments for each branch of code.

Squash offers three types of user accounts: Admin Technical Admin Member Admin Role This is the default role for the first user in a personal or organization account. Admins have full access to the account, including billing. Technical Admin This role has the same access as Admin, except billing. Member Members have access to the

Read more

Updating the Deployment Cache

Avatar

squashlabs, March 28, 2019

All Squash APIs are currently not available for accounts under the free plan. For more details please go to our plans page. This API call will start a new deployment to force a Deployment Cache (DC) update. Squash will update the cache during the shutdown process of the deployment. This is useful for relatively large

Read more

Updating Assets

Avatar

squashlabs, March 28, 2019

All Squash APIs are currently not available for accounts under the free plan. For more details please go to our plans page. After submitting API calls it may take from 1 to 3 minutes for the changes to be fully propagated. This depends on the number and size of the files updated within the assets

Read more

Authentication

Avatar

squashlabs, March 28, 2019

All Squash APIs are currently not available for accounts under the free plan. For more details please go to our plans page. Squash offers a REST API to interact with the service. The response body is in JSON format. Authentication is key based only. API Keys You can create API keys to access the service by

Read more

Assets

Avatar

squashlabs, March 24, 2019

When the Assets Storage is enabled Squash will automatically add a new /assets/ mount point for all deployments within the repository. You can upload up to 100GB of data in this folder (additional charges apply, check out the pricing page). How to enable the Assets Storage Step 1 Go to the Squash Admin page and then click on Settings -> Repositories

Read more

Squash HTTP Headers

Avatar

squashlabs, March 24, 2019

Squash provides custom HTTP headers that are always send to the applications running within Squash deployments. These headers provide users with more flexibility at the web server level. Squash-Server This header always have the value true and is used to signal to applications that the request is coming from Squash. This is handy if you need to

Read more

Environment Variables

Avatar

squashlabs, March 24, 2019

Custom Environment Variables You can define custom environment variables from the Squash admin interface. Go to Settings -> Repositories and then click on “Settings” for a given repository. Each environment variable defined on this page will become available within the deployment host. They can also become available within docker containers with a few configuration steps (see

Read more

The Squash YAML file

Avatar

squashlabs, March 24, 2019

You can define a .squash.yml at the root level of your repository. This file provides greater flexibility to control the build and execution of each deployment. Squash works out of the box without the need of a .squash.yml file. In this case Squash searches for a Dockerfile or docker-compose.yml file within the root path of your application code. More detail on

Read more

Success Responses

Avatar

squashlabs, March 24, 2019

Note: You may customize the success routing logic by using the success_response_check field. Squash uses any of the HTTP response codes below in order to recognize a success response from the application running in the Docker container: 200 401 300 301 302 When one of these status codes is received, Squash will update its internal

Read more

The VM Build Process

Avatar

squashlabs, March 24, 2019

When you start a new deployment Squash will perform the following steps in this order below. You may also check this quick intro on how Squash works. Finding a Build plan Squash first searches for a Squash YAML file. If the file is not present then it checks if there is a deployment profile defined

Read more