Locally editing the deployable architecture stack definition

Using the console to create the stack definition in a project

In a project, your stack definition is created automatically when you stack deployable architectures together and define stack variables. Using the console to stack deployable architectures and define stack variables provides the following benefits:

• You can use the reference picker in the console to create references between deployable architectures in the stack, as opposed to writing the references from scratch.
• Deploying the stack from a project helps verify the stack works as designed before others configure and deploy it.
• Since the stack definition is created automatically based on the selections in the console, information like version locator IDs of member deployable architectures is accurate and updated automatically.

In the project, you can select which inputs you want included at the stack level. These inputs are included in the inputs section of the stack definition and are configured as references in the member deployable architecture in your project. In the following image, the prefix input is highlighted within the Custom Apache member deployable architecture. If this input is selected, the Default value changes to a reference to the stack level input. When a user adds the stack to a project from a catalog, they can configure the prefix input and the Custom Apache member architecture will reference that value. The fp_vsi_floating_ip_address input references an output from another member deployable architecture. That input shouldn't be selected, as that reference links the member architectures together within the stack. Such inputs from member architectures are included in the members section of the stack definition file.

Editing your stack definition

To edit your stack definition locally, complete the following steps:

1. Complete the steps to stack the deployable architectures, define stack variables, and onboard the stack to a private catalog.

   Configure and deploy the stack to verify that it works as designed before adding the stack to a private catalog.

2. After the deployable architecture stack is added to your private catalog, you are taken to the Configure version page in the catalog. From there, click the Actions menu > Export as code.

   You can also use the projects API Get a stack definition method or the projects CLI ibmcloud project stack-definition command to export the stack definition.

3. Open the stack_definition.json file.

4. Using the example definition as a guide, edit the input and output variables.

5. Add the file into the root folder of your source code repository.

The next time that you add a new version of your stacked deployable architecture to the catalog, your updates will be included.

Example definition file

Though it's recommended to use a project to create the stack definition to help ensure accuracy, the following code snippet can be used as a template to create the stack definition from scratch.

{
   "inputs": [
      {
         "name": "Stack input 1",
         "type": "string",
         "hidden": false,
         "required": true,
         "default" : "Default value"
      },
      {
         "name": "Stack input 2",
         "type": "string",
         "hidden": false,
         "required": true
      }
   ],
   "outputs": [
      {
         "name": "Output 1 name",
         "value": "The reference to this output value"
      },
      {
         "name": "Output 2 name",
         "value": "The reference to this output value"
      }
   ],
   "members": [
      {
         "Name": "Deployable architecture 1 name",
         "Version_locator": "",
         "inputs": [
            {
               "name": "Input 1 name",
               "value": "reference"
            },
            {
               "name": "Input 2 name",
               "value": "reference"
            }
         ]
      },
      {
         "Name": "Deployable architecture 2 name",
         "Version_locator": "",
         "inputs": [
            {
               "name": "Input 1 name",
               "value": "reference"
            },
            {
               "name": "Input 2 name",
               "value": "reference"
            }
         ]
      }
   ]
}

"inputs": [
   {
      "name": "Stack input 1",
      "type": "string",
      "hidden": false,
      "required": true,
      "default" : "Default value"
   },
   {
      "name": "Stack input 2",
      "type": "string",
      "hidden": false,
      "required": true
   }
]

"outputs": [
   {
      "name": "Output 1 name",
      "value": "The reference to this output value"
   },
   {
      "name": "Output 2 name",
      "value": "The reference to this output value"
   }
]

"members": [
   {
      "Name": "Deployable architecture 1 name",
      "Version_locator": "",
      "inputs": [
         {
            "name": "Input 1 name",
            "value": "reference"
         },
         {
            "name": "Input 2 name",
            "value": "reference"
         }
      ]
   }
]