The information on this page is written for Vamp v0.9.3
With any artifact, Vamp allows you to either use an inline notation or reference the artifact by name. For references, you use the
reference keyword or its shorter version
ref. Think of it like either using actual values or pointers to a value. This has a big impact on how complex or simple you can make any blueprint, breed or deployment. It also impacts how much knowledge you need to have of all the different artifacts that are used in a typical deployment or blueprint.
Vamp assumes that referenced artifcats (the breed called
my_breed in the example below) is available to load from its datastore at deploy time. This goes for all basic artifacts in Vamp: SLA’s, gateways, conditions, escalations, etc.
Example - reference notation
--- name: my_blueprint clusters: my_cluster: services: breed: name: my_breed deployable: registry.example.com/app:1.0 scale: cpu: 2 memory: 1024MB instances: 4
--- name: my_blueprint clusters: my_cluster: services: breed: reference: my_breed scale: reference: medium
Working with references
When you begin to work with Vamp, you will probably start with inline artifacts. You have everything in one place and can directly see what properties each artifact has. Later, you can start specialising and basically build a library of often used architectural components.
Example use of references
Create a library of containers
Use case: You have a Redis container you have tweaked and setup exactly the way you want it. You want to use that exact container in all your environments (dev, test, prod etc.).
Implementation: Put all that info inside a breed and use either the Vamp UI or API to save it (below). Now you can just use the
ref: redis:1.0 notation anywhere in a blueprint.
--- name: redis:1.0 deployable: redis ports: 6379/tcp
Fix scales per environment
Use case: You want to have a predetermined set of scales you can use per deployment per environment. For instance, a “medium_production” should be something else than a “medium_test”.
Implementation: Put all that info inside a scale and use either the Vamp API to save it (below). Now you can use the
ref: medium_test or
ref: medium_prod notation anywhere a
scale type is required.
--- name: medium_prod cpu: 2 memory: 4096MB instances: 3
--- name: medium_test cpu: 0.5 memory: 1024MB instances: 1
Reuse a complex condition
Use case: You have created a complex condition to target a specific part of your traffic. In this case users with a cookie that have a specific session variable set in that cookie. You want to use that condition now and then to do some testing.
Implementation: Put all that info inside a condition and use either the Vamp API to save it (below). Now you can use the
ref: condition_empty_shopping_cart anywhere that
condition is required.
--- name: condition_empty_shopping_cart condition: Cookie SHOPSESSION Contains shopping_basket_items=0
Last updated on September 7, 2018