Skip to content

Commit

Permalink
Fix review comments
Browse files Browse the repository at this point in the history
  • Loading branch information
reshmabidikar committed Nov 26, 2024
1 parent c6400da commit 57b4e9e
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 19 deletions.
18 changes: 11 additions & 7 deletions userguide/aviate/aviate-catalog.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,14 @@ The Aviate plugin can be installed as documented in the [How to Install the Avia

To use the catalog API capabilities provided by the Aviate plugin, ensure that KB is started with the following properties:

```
[source,bash]
----
com.killbill.billing.plugin.aviate.enableCatalogApis=true
com.killbill.billing.plugin.aviate.enableHealthReporter=false //TODO is this required?
com.killbill.billing.plugin.aviate.enableMigrations=true //TODO - is this required?
```
----

=== Using Catalog Plugin APIs

Once the plugin is installed and enabled, you can start using the Catalog Plugin APIs. As mentioned earlier, the Aviate catalog plugin exposes endpoints that operate at a plan/product/pricelist level. These endpoints allow plan/product/pricelist creation/modification and deletion. At the time of writing, only plan-level endpoints are supported. The catalog API endpoints are documented in our https://killbill.github.io/slate/aviate-catalog-apis.html[slate docs].
Once the plugin is installed and enabled, you can start using the Catalog Plugin APIs. As mentioned earlier, the Aviate catalog plugin exposes endpoints that operate at a plan/product/pricelist level. These endpoints allow plan/product/pricelist creation/modification and deletion. At the time of writing, only plan-level endpoints are supported. The catalog API endpoints are documented in our https://apidocs.killbill.io/aviate-catalog-apis[slate docs].

== Catalog Versioning

Expand All @@ -38,14 +37,15 @@ Each plan stored within the Aviate catalog plugn has an associated `effectiveDat

Assuming we have the following plans, Pa, Pb, Pc, and we create those at different times and modify those to allow for price changes, we get the following:

```
[source,bash]
----
* T1: Create Pa -> 1 catalog version v1={Pa}
* T2: Create Pb -> 1 catalog version v1={Pa, Pb}
* T3: Modify Pa -> 2 catalog versions v1={Pa, Pb}, v2={Pa', Pb} // Pa' with the new price
* T4: Create Pc -> 2 catalog versions v1={Pa, Pb}, v2={Pa', Pb, Pc} // Pa' with the new price
* T5: Modify Pb -> 3 catalog versions v1={Pa, Pb}, v2={Pa', Pb, Pc}, v3={Pa', Pb', Pc} // Pa' and Pb' with the new price
...
```
----

== FAQ

Expand All @@ -57,5 +57,9 @@ When the Aviate catalog plugin is enabled, the catalog state is managed by the A

Yes, it is possible to use the KB price overrides feature. In other words, even if the Aviate catalog plugin is enabled, it is still possible to create a subscription with price overrides.

// TODO - Add Further Reading section once we have more documentation on Aviate plugin





24 changes: 12 additions & 12 deletions userguide/aviate/how-to-install-the-aviate-plugin.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ include::{sourcedir}/aviate/includes/aviate-card.adoc[]

== Plugin Installation

The Aviate plugin is not an open-sourced plugin and hence cannot be installed using the standard https://docs.killbill.io/latest/plugin_installation#_plugin_installation[__plugin installation steps__].

This section lists the steps to be followed for the Aviate plugin installation.

//TODO - Steps to create the DB tables are not mentioned here, I'm assuming that com.killbill.billing.plugin.aviate.enableMigrations=true will automatically create the tables?
Expand All @@ -22,7 +20,8 @@ This section lists the steps to be followed for the Aviate plugin installation.

The aviate plugin can be installed by running the following curl command:

```
[source,bash]
----
curl -v \
-u admin:password \
-H "Content-Type: application/json" \
Expand Down Expand Up @@ -59,15 +58,16 @@ curl -v \
"isSystemCommandType": "true"
}' \
"http://127.0.0.1:8080/1.0/kb/nodesInfo"
```
----

Replace `<token>` with your cloudsmith token. Replace `<version>` with the plugin version to be installed. This should be something like `1.0.12`.

*Step 2 - Start the Plugin*

In order to start the plugin, run the following `curl` command:

```
[source,bash]
----
curl -v \
-u admin:password \
-H "Content-Type: application/json" \
Expand All @@ -84,23 +84,23 @@ curl -v \
"isSystemCommandType": true
}' \
"http://127.0.0.1:8080/1.0/kb/nodesInfo"


```
----

*Step 3 - Verify that the plugin is running*

Run the following `curl` command:

```
[source,bash]
----
curl -v \
-u admin:password \
http://127.0.0.1:8080/1.0/kb/nodesInfo
```
----

The output should contain an entry similar to the following:

```
[source,bash]
----
{
"bundleSymbolicName": "com.kill-bill.billing.plugin.java.aviate-plugin",
"pluginKey": "aviate-plugin",
Expand All @@ -123,7 +123,7 @@ The output should contain an entry similar to the following:
}
]
}
```
----
Alternatively, you can verify this via Kaui. To do this, click on the plug icon and the kpm link. Verify that the Aviate plugin is displayed in green color in RUNNING status.

== Further Reading
Expand Down

0 comments on commit 57b4e9e

Please sign in to comment.