diff --git a/fabric/api-documentation.md b/fabric/api-documentation.md new file mode 100644 index 00000000..575f78ba --- /dev/null +++ b/fabric/api-documentation.md @@ -0,0 +1,33 @@ +--- +title: API Documentation +--- + +# API Documentation + +Harper provides automatically generated API documentation page via [Swagger UI](https://github.com/swagger-api/swagger-ui) integration. This page allows developers to explore and test the various API endpoints available in your Harper instance/cluster. + +## Accessing the API Documentation + +To access the API documentation, navigate to the following URL in your web browser: + +1. Sign in to your Harper Fabric Studio. +2. Select your Organization and Cluster. +3. Sign in to the Cluster and navigate to the `APIs` tab in the sub-menu. + +## API Execution + +In order to execute API calls directly from the Swagger UI: + +1. Click an endpoint to expand it. +2. Enter the required information in the provided fields under the "Parameters" tab. +3. Scroll down and click the "Execute" button. +4. The server response from the API call will be displayed below, including HTTP status code, and response body. + +## Authorize + +To authorize API requests, you need to include a valid basic authentication header or bearer authentication token. + +1. Click on the "Authorize" button in the Swagger Documentation UI. +2. Choose your preferred authentication method (Basic or Bearer) and enter your credentials or token. +3. Click the "Authorize" button to apply the authentication key to all subsequent requests. +4. Execute an API call to verify that the authorization was successful. diff --git a/fabric/cluster-creation-management.md b/fabric/cluster-creation-management.md index c9ac02e6..6cd2212d 100644 --- a/fabric/cluster-creation-management.md +++ b/fabric/cluster-creation-management.md @@ -23,6 +23,19 @@ A cluster is a group of instances managed together to run applications and servi 5. \*Confirm or replace the preferred payment method. Add a new card if necessary 6. Cluster will begin provisioning as soon as you complete your selections. +## Editing a Cluster + +To edit an existing cluster: + +1. Navigate to your organization page. +2. Locate the cluster you want to edit in the list of clusters. +3. Click the three dots menu next to the cluster name and select "Edit" from the dropdown. +4. Make the necessary changes to the cluster configuration such as: + - Performance & Usage + - Modifying the Region location and Estimated P90 Latency + - Adding or removing additional regions. +5. Click the "Save Changes" or "Confirm Payment Details" button to summarize and apply your modifications. + ## Harper Deployment Types: ### Colocated: diff --git a/fabric/grafana-integration.md b/fabric/grafana-integration.md new file mode 100644 index 00000000..e1843227 --- /dev/null +++ b/fabric/grafana-integration.md @@ -0,0 +1,43 @@ +--- +title: Grafana Integration +--- + +# Setup Grafana Integration with Harper + +Grafana is an observability platform for monitoring and visualizing metrics, logs, and traces. Harper provides a plugin to integrate with Grafana for enhanced analytics and visualization capabilities. + +To install the Harper Grafana integration: + +1. Navigate to Harper's plug-in inside the [Grafana marketplace](https://grafana.com/grafana/plugins/harperfast-harper-datasource/). +2. Sign-in to your Grafana account. If you do not have an account, you will need to create one. +3. Click the "Get plugin" button. + +## Installing on a Local/Self-Hosted Grafana Instance + +4. Follow the steps under "[Installing on a local Grafana](https://grafana.com/grafana/plugins/harperfast-harper-datasource/?tab=installation)" + +## Connect to Harper + +4. Navigate to your Grafana instance URL specified under `Installing Harper on Grafana Cloud`. +5. On the left sidebar, click the `Connections` navigation link and select `Add new connection` +6. In the search bar, type `Harper` to filter the list of available data source plugins. +7. On the top right corner, click the `Add new data source` button. +8. You will be directed to the `Settings` page for the new data source. Configure the following settings: + - **Name**: Provide a name for the data source (e.g., `My Fabric Cluster Analytics`). + - **Operations API URL**: Enter the URL to your Harper Fabric cluster's operations API + - Found in Harper Fabric Studio navigating to the cluster: + - Clicking the three dots and selecting `Copy API Url`. + - Add `:9925` to the end of the URL if not already present. + - **Username**: Enter a username with permission to use the analytics ops in the Operations API. + - **Password**: Enter the password for the specified username. +9. Click the `Save & Test` button to save the data source configuration and test the connection. You should see a message indicating that the data source is working. + +## Building Dashboards + +Once the Harper data source is configured, you can start building dashboards in Grafana. + +## Explore + +1. Click on the `Explore` navigation link in the left sidebar. +2. You can now create queries using the Harper data source to visualize your Harper Fabric cluster metrics and logs. + Reference the [Harper Analytics Operations](../docs/developers/operations-api/analytics) for more details on available metrics and query options. diff --git a/sidebarsFabric.ts b/sidebarsFabric.ts index 3c69e0c7..9a85e6d5 100644 --- a/sidebarsFabric.ts +++ b/sidebarsFabric.ts @@ -32,6 +32,11 @@ const sidebarsFabric: SidebarsConfig = { id: 'managing-applications', label: 'Managing Applications', }, + { + type: 'doc', + id: 'api-documentation', + label: 'API Documentation', + }, { type: 'doc', id: 'database-management', @@ -42,6 +47,11 @@ const sidebarsFabric: SidebarsConfig = { id: 'logging', label: 'Logging', }, + { + type: 'doc', + id: 'grafana-integration', + label: 'Grafana Integration', + }, { type: 'autogenerated', dirName: 'fabric' }, ], };