Set up a pre-built use case
Last updated
Last updated
Now that you've chosen your use case, you're ready to experience Kubiya's rapid time-to-automation. In the web app's "Create New Use Case" page select your use case and click continue.
On the next screen, you will see a form requesting inputs from you. As a reminder, each use case is a Terraform module that is being rendered via Kubiya's web app. This form specifically is the module's variables.tf file being presented via UI.
Proceed by entering values for these variables, after which Kubiya will run a Terraform Plan behind the scenes.
Each use case has its own respective prerequisites – Kubiya resources that are required for the use case to function properly. These are usually presented as dropdown lists within the form, via which you can select from the resources you've already created in Kubiya.
Prerequisite resources vary by use case. For example, a Kubiya runner is necessary for all use cases but other resources like integrations, secrets, and knowledge are only necessary for some use cases.
Local runners vs. hosted runners:
While all use cases require a runner, only Kubernetes use cases require a local runner. For all other use cases, a hosted runner will suffice.
If you haven't set up any of these resources yet, don't worry – you can create them from within this page. When clicking on the dropdown list for that resource, you'll see an option to create one.
For example in the integration dropdown, there's an option + Add Integration. Upon clicking it, you will receive on-screen instructions for setting up the resource.
After entering values for all of the variables, click save and continue in the top right corner. Upon clicking this, Kubiya will execute Terraform Plan via Terraform Cloud.
On the bottom of the screen, you will see output from your Terraform Plan, summarizing the resources that will be created. If successful, you will be brought to the next screen where you'll be able to review and run Terraform Apply.
If there are any issues, you'll be asked to fix the issues and then try clicking save & continue again.
On this final screen, you'll see a summary of all resources that will be created in Kubiya (e.g. an AI Teammate) and externally (e.g. a webhook in GitHub) as part of your use case.
To finish setting up your use case, click the Delegate button in the top right corner. When you click this, Kubiya will execute Terraform Apply via Terraform Cloud.
You may need to wait a few moments for the Terraform Apply to finish. After that, you will be taken to the use cases page where you will see a new list item for your use case.
While on the use case list page, be sure to refresh the page to see the updated status of your use case. If the status is active, then congrats your use case is live and ready to go!
Provisioning: Resource provisioning is still in progress.
Active: Resource provisioning was successful. Your use case has officially been delegated and your Kubiya Teammate can now perform it.
Error: If Terraform Apply fails, a banner message will inform you that the use case could not be created, with a prompt to view the use case details for more information.
Draft: The use case setup hasn't been completed, i.e. the Delegate button hasn't been clicked yet.
In some cases, there might be an error. In this case, click on the use case to view a more detailed error message and steps to resolve it. If you're having trouble, please reach out to our team at support@kubiya.ai.
Note: Resources created by your use case
Kubiya resources created by a use case must be updated by making updates to the use case. In other words, it is "managed by the use case" – i.e. the Terraform module via which it was created.
variables.tf file being rendered in Kubiya's UI.variables.tf file
