Skip to content

Commit fb698a4

Browse files
committed
Aviate Deployment Management doc
1 parent 96aeda1 commit fb698a4

File tree

2 files changed

+62
-0
lines changed

2 files changed

+62
-0
lines changed

html5/_main_toc.html.slim

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -318,6 +318,9 @@ nav.sidebar-nav
318318
li
319319
a.nav-link href="/latest/aviate-changelog.html"
320320
| Aviate Changelog
321+
li
322+
a.nav-link href="/latest/aviate-deployment-management.html"
323+
| Deployment Management
321324
li
322325
a.nav-link href="/latest/aviate-getting-started.html"
323326
| Getting Started
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
= Aviate Deployment Management
2+
3+
This guide explains how to add/manage a custom Kill Bill deployment in the https://aviate.killbill.io[Aviate UI].
4+
5+
== Prerequisites
6+
7+
* Access to the https://aviate.killbill.io[Aviate UI] with a valid Flock account.
8+
* A running Kill Bill instance accessible from your network.
9+
* Administrative credentials for your Kill Bill instance (API key, API secret, and admin user credentials).
10+
11+
== Add a Local Deployment
12+
13+
You can add a local deployment to Aviate by providing the connection details (URL and credentials) for your Kill Bill instance. This allows you to manage your Kill Bill instance directly from the Aviate UI.
14+
15+
Once a deployment is added, Aviate allows you to perform a wide range of management actions, including but not limited to:
16+
17+
* Installing and managing plugins
18+
* Creating and managing product plans and catalogs
19+
* Configuring plugins and their properties
20+
* Uploading and managing invoice templates
21+
* Setting and updating tenant properties
22+
* Monitoring deployment status and plugin health
23+
24+
Refer to the following demo for a walkthrough of the process to add a local deployment in Aviate:
25+
26+
:storylane-id: uamhutfpgj7q
27+
:storylane-embed-type: inline
28+
include::{sourcedir}/includes/storylane-embed.adoc[]
29+
30+
== Add a Tenant to an Existing Deployment
31+
32+
You can also add a new tenant to an existing deployment. This allows you to manage multiple tenants within the same Kill Bill instance from Aviate.
33+
34+
Refer to the following demo for a walkthrough of the process to add a tenant to an existing deployment in Aviate:
35+
36+
:storylane-id: 83wimvrsbani
37+
:storylane-embed-type: inline
38+
include::{sourcedir}/includes/storylane-embed.adoc[]
39+
40+
== Edit the Deployment
41+
42+
You can edit the deployment details (e.g., URL, credentials, etc.) at any time from the Aviate UI. This is useful if you need to update the connection information or credentials for your Kill Bill instance.
43+
44+
Refer to the following demo for a walkthrough of the process to edit a deployment in Aviate:
45+
46+
:storylane-id: itb3ko5nt4lq
47+
:storylane-embed-type: inline
48+
include::{sourcedir}/includes/storylane-embed.adoc[]
49+
50+
== Delete the Deployment
51+
52+
You can delete a deployment from the Aviate UI if you no longer want to manage it through Aviate.
53+
54+
Refer to the following demo for a walkthrough of the process to delete a deployment in Aviate:
55+
56+
57+
:storylane-id: zgsvpxse48pe
58+
:storylane-embed-type: inline
59+
include::{sourcedir}/includes/storylane-embed.adoc[]

0 commit comments

Comments
 (0)