Fabric Studio Docs

docs/administration/harper-studio/create-account.md

@@ -4,7 +4,7 @@ title: Create a Studio Account
 
 # Create a Studio Account
 
-Start at the [Harper Studio sign up page](https://studio.harperdb.io/sign-up).
+Start at the [Harper Studio sign up page](https://fabric.harper.fast/#/sign-up).
 
 1. Provide the following information:
    - First Name

docs/administration/harper-studio/enable-mixed-content.md

@@ -4,6 +4,6 @@ title: Enable Mixed Content
 
 # Enable Mixed Content
 
-Enabling mixed content is required in cases where you would like to connect the Harper Studio to Harper Instances via HTTP. This should not be used for production systems, but may be convenient for development and testing purposes. Doing so will allow your browser to reach HTTP traffic, which is considered insecure, through an HTTPS site like the Studio.
+If you want to connect insecure HTTP instances from the secure HTTPS Fabric Studio, you can enable mixed content temporarily. This isn't recommended in production systems. It would be better to add HTTPS / SSL Termination in front of your instances. But if you understand the risks, you can enable mixed content. Enabling mixed content is required in cases where you would like to connect the Harper Studio to Harper Instances via HTTP. This should not be used for production systems, but may be convenient for development and testing purposes. Doing so will allow your browser to reach HTTP traffic, which is considered insecure, through an HTTPS site like the Studio.
 
 A comprehensive guide is provided by Adobe [here](https://experienceleague.adobe.com/docs/target/using/experiences/vec/troubleshoot-composer/mixed-content.html).

docs/index.mdx

@@ -17,6 +17,7 @@ Here, you'll find all things Harper, and everything you need to get started, tro
 ## Getting Started
 
 The recommended approach for efficiently developing applications with Harper is to develop locally and deploy them to Harper Fabric, our distributed data application platform service. Our getting started guide will walk you through how to install Harper locally, sign up for Fabric service, build a simple application and deploy it.
+
 <CustomDocCardList
 	columns={3}
 	items={[

fabric/cluster-creation-management.md

@@ -0,0 +1,45 @@
+---
+title: Cluster Creation & Management
+---
+
+# Cluster Creation & Management
+
+## What is a Cluster?
+
+A cluster is a group of instances managed together to run applications and services within a Harper organization; it is the deployable environment where your workloads live. Clusters can be created and managed directly from the Fabric Studio UI (no DevOps required!)
+
+## Creating a Cluster
+
+1. Navigate to your organization page.
+2. Click the "+ New Cluster" button in the upper right of the sub-menu.
+3. Enter the required fields:
+   - **Cluster Name**: A unique name for your cluster within the organization.
+   - **Harper Deployment**: Choose between Colocated, Dedicated, or Self-hosted (see below for details).
+   - **Performance & Usage**: Select the cluster size that best fits your needs. Examples include Free, Medium, High, Very High.
+   - **Host Name (Full Host Name)**: Enter the host name for your cluster. This will be part of the URL used to access your cluster (e.g., `<cluster name>.<your organization subdomain>.harperfabric.com`).
+   - **Region**: Select the geographic region where you want your cluster to be hosted. Examples include US, Global, Europe.
+   - **Estimated P90 Latency, Distribution**: Displays estimated latency based on your selected region and instance size.
+4. Click the "Confirm Payment Details" or "Create New Cluster"(if you chose the free tier) button on the bottom right of the page.
+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.
+
+## Harper Deployment Types:
+
+### Colocated:
+
+Multi-tenant clusters are deployed on shared hosts alongside clusters from other organizations, but data and workloads remain completely isolated. Colocated deployments are optimal for organizations seeking excellent performance across available regions.
+
+### Dedicated:
+
+Dedicated clusters run on hosts reserved for a single organization. These environments are available in ten more specialized regions, and offer performance isolation and higher resource limits. Dedicated deployments are ideal for organizations with stricter compliance or performance requirements
+
+### Self-hosted:
+
+Self-hosted clusters are provisioned entirely outside of Harper’s infrastructure, on an organization's owned and operated servers or cloud accounts.
+Please follow the cluster configuration menu for more information on estimated performance and cost. Clusters will begin provisioning as soon as you complete your selections.
+Clusters are provisioned in real time, as soon as selections are complete
+
+### Additional Information:
+
+- Cannot guarantee any provisioning time for self-hosted. (**Note**: All performance metrics are estimates unless otherwise noted.)
+- Once a cluster is created, you will be prompted to set a username and password for each cluster.

fabric/create-account.md

@@ -0,0 +1,20 @@
+---
+title: Create a Fabric Studio Account
+---
+
+# Create a Fabric Studio Account
+
+Start at the [Harper Fabric Studio sign up page](https://fabric.harper.fast/#/sign-up).
+
+1. Provide the following information:
+   - First Name
+   - Last Name
+   - Email Address
+   - Password
+
+2. Review the Privacy Policy and Terms of Service.
+3. Click the "Sign Up For Free" button.
+4. Once you complete the sign-up form, you will receive a verification email. Click the link in the email to verify your account.
+5. After verifying your email, you can log in to Fabric Studio using your email address and password.
+
+Note: Your email address will be used as your username and cannot be changed.

fabric/create-organization.md

@@ -0,0 +1,25 @@
+---
+title: Create an Organization
+---
+
+# Create an Organization
+
+What is an organization?
+An organization is a way to group and manage multiple clusters and users within Fabric Studio. Organizations help you:
+
+- Organize your clusters and resources
+- Control access based on roles and permissions
+- Collaborate with team members effectively.
+- Manage billing and subscriptions for multiple clusters under a single entity.
+
+To create a new organization in Fabric Studio, follow these steps:
+
+1. Log in to your Fabric Studio account.
+2. Click on the "New Organization" button in the right of the sub-menu.
+3. Enter Organization Details:
+   - **Name**: The name of your organization.
+   - **Subdomain**: This will be part of the host name URL for accessing your organization's clusters (e.g., with subdomain "acme" the cluster full host name would be: `<cluster name>.acme.harperfabric.com`).
+
+4. Click the "Create New Organization" button to finalize the creation of your new organization.
+
+Once your organization is created, you can invite team members and manage your organization's settings.

fabric/database-management.md

@@ -0,0 +1,63 @@
+---
+title: Database Management
+---
+
+# Database Management
+
+## Import CSV Data
+
+1. Navigate to the "Database" tab in the sub-menu
+2. Select the desired database and table. If no tables exist, create a new table first.
+3. Click the "Import CSV" button located above the table view.
+4. Select/Drag-and-drop the CSV file from your local machine.
+5. Click the "Upload CSV" button to import the data into the selected table.
+6. The data will be uploaded and displayed in the table view. This may take a few moments depending on the size of the file.
+7. Refresh the table view by clicking the "Refresh" button if necessary.
+
+## Add a New Record
+
+1. Navigate to the "Database" tab in the sub-menu
+2. Select the desired database and table.
+3. Click the "Add New Record" button located above the table view.
+4. Fill in the necessary fields in the form that appears.(These fields will correspond to the columns/schema in the selected table.)
+5. Click the "Save" button to add the new record to the table.
+
+## Create a New Table
+
+1. Navigate to the "Database" tab in the sub-menu
+2. Select the desired database.
+3. Click the "Create a Table" button located to the left of the table view.
+4. Fill in the:
+   - Table Name: The name of the new table.
+   - Primary Key: The primary key field for the table.
+   - Database Name: The database where the table will be created.(Will automatically fill based upon the selected database where the table is being created.)
+5. Click the "Create New Table" button to create the new table.
+6. The new table will appear in the table list on the left side of the screen.
+
+## Delete a Table
+
+1. Navigate to the "Database" tab in the sub-menu
+2. Select the desired database and table.
+3. Click the three dots button located above the table view on the top right.
+4. Select "Drop Table" from the dropdown menu.
+5. Confirm the deletion by clicking the "Drop" button in the confirmation dialog.
+6. The table will be deleted from the database.
+
+## Delete a Record
+
+1. Navigate to the "Database" tab in the sub-menu
+2. Select the desired database and table.
+3. Locate the record you want to delete in the table view.
+4. Click the record and a modal will appear.
+5. Click the "Delete Row" button in the modal to confirm the deletion.
+6. The record will be deleted from the table.
+
+## Edit a Record
+
+1. Navigate to the "Database" tab in the sub-menu
+2. Select the desired database and table.
+3. Locate the record you want to edit in the table view.
+4. Click the record and a modal will appear.
+5. Edit the fields as necessary in the modal.
+6. Click the "Save Changes" button to save the changes to the record.
+7. The updated record will be displayed in the table view.

fabric/index.md

@@ -1,3 +1,21 @@
-# Fabric
+---
+title: Fabric Studio
+---
 
-Welcome to the Fabric documentation.
+# Fabric Studio
+
+Fabric Studio is the web-based GUI for Harper. Studio enables you to administer, navigate, and monitor all of your Harper clusters in a simple, user-friendly interface without any knowledge of the underlying Harper API. It’s free to sign up, get started today!
+
+[Sign up for free!](https://fabric.harper.fast/#/sign-up)
+
+Harper includes a simplified local Studio that is packaged with all Harper installations and served directly from the cluster. It can be enabled in the [configuration file](../docs/deployments/configuration#localstudio). This section is dedicated to the hosted Studio accessed at [studio.harperdb.io](https://fabric.harper.fast/).
+
+---
+
+## How does Studio Work?
+
+While Fabric Studio is web based and hosted by us, all database interactions are performed on the Harper cluster the studio is connected to. The Harper Studio loads in your browser, at which point you login to your Harper clusters. Credentials are stored in your browser cache and are not transmitted back to Harper. All database interactions are made via the Harper Operations API directly from your browser to your cluster.
+
+## What can I manage?
+
+Fabric Studio enables users to manage both Harper Cloud clusters and privately hosted clusters all from a single UI. All Harper clusters feature identical behavior whether they are hosted by us or by you.

fabric/logging.md

@@ -0,0 +1,34 @@
+---
+title: Logging
+---
+
+# Logging
+
+## Log Filtering
+
+Log filtering allows users to customize the log output based on specific criteria. This can help in isolating relevant information and reducing noise in the logs list.
+To filter logs:
+
+1. Navigate to the "Logs" section in Fabric Studio.
+2. Use the filter options available at the left side menu logs list to specify criteria such as:
+   - Log Limit: The maximum number of log entries to display(e.g. 10, 100, 250, 500, 1000) (default is 100)
+   - Log Level (e.g., Error, Warn, Info, Debug, Trace, Notify, All) (default is All)
+   - Start Date: The beginning date and time for the log entries to display
+   - End Date: The ending date and time for the log entries to display
+
+3. Click the "Apply Filters" button to update the log list based on the selected criteria.
+4. The log list will refresh to show only the entries that match the specified filters.
+
+## Log Details
+
+To view detailed information about a specific log entry:
+
+1. Navigate to the "Logs" section in Fabric Studio.
+2. Click on a log entry in the logs list to open the log details modal.
+3. The log details modal will display comprehensive information about the selected log entry, including:
+   - Timestamp: The date and time when the log entry was created
+   - Level: The severity level of the log entry (e.g., Error, Warn)
+   - Thread: The thread identifier where the log entry originated
+   - Tags: Any associated tags for categorizing the log entry
+   - Message: The main content of the log entry
+4. Review the information in the modal to gain insights into the specific event or issue recorded in the log entry.

fabric/managing-applications.md

@@ -0,0 +1,39 @@
+---
+title: Managing Applications
+---
+
+# Managing Applications
+
+After setting a username/password for cluster, you will automatically be directed to the applications page for the cluster. From here, users can either import or create an application to run on Harper.
+
+## Creating a New Application
+
+To create a new application:
+
+1. Select "Applications" from the menu if not already there
+2. Click the "+ New Application" button in the upper right of the sub-menu
+3. Enter the "New Application Name" (max 75 characters)
+4. Click "Create"( **Note**: this will prompt the cluster to restart)
+5. Your new application will appear in the applications list
+
+## Importing an Application
+
+To import an existing application:
+
+1. Select "Applications" from the menu if not already there
+2. Click the "Import Application" button in the center of the page
+3. Enter the "Application Name" (max 75 characters)
+4. Enter the "Package Reference URL" (must be a valid URL)
+5. Click "Create"( **Note**: this will prompt the cluster to restart)
+6. Your imported application will appear in the applications list
+
+## Updating an application
+
+To update an existing application:
+
+1. Select "Applications" from the menu if not already there
+2. Click the top level name of the application in the applications list
+3. Select "Redeploy Application"
+4. Enter the new "Package Reference URL" (must be a valid URL)
+5. Click "Redeploy"( **Note**: this will prompt the cluster to restart)
+6. Your application will be updated and redeployed.

fabric/organization-management.md

@@ -0,0 +1,39 @@
+---
+title: Organization Management
+---
+
+# Organization Management
+
+Organizations can be managed in a variety of ways, including: roles and user permissions, adding/removing users, creating new environments (clusters) and updating billing information.
+
+## Role Management
+
+Organizations can be made up of many users, each with different roles and permissions. Roles and permissions can be created and managed by the organization admin.
+
+### Creating a new role
+
+1. Navigate to the organization page
+2. Click "Roles" in the menu on top of screen
+3. User will be navigated to role table
+4. Note: “admin” will appear in role table as default role, with 1 user (creator) assigned. Admins can update and delete organizations
+5. Click on “+ Add” button in top right corner and a modal will appear
+6. Enter role information:
+
+- Role Name: name of the new role
+- Can update organization: toggle on/off
+- Can delete organization: toggle on/off
+- JSON Permissions: enter custom JSON permissions
+
+7. Click "Save Changes" button to create new role
+   Create and customize as many roles as appropriate for organization
+
+### User management
+
+1. Select “Users” from menu on top of screen
+2. List of all active users from organization will appear
+3. Note: organization creator will default as active admin, with a precreated user ID
+4. To add new users, click “+ Add” icon in top right corner
+5. Enter new user’s email
+6. Select desired role from drop down. (**Note**: roles and associated permissions can be created and managed by organization admins)
+7. Click "Add User" button to finalize adding new user
+   **Note**: If they don't yet have a Fabric account, you will be prompted to invite them. They will be sent a verification email with instructions on how to activate their account. Once accepted, the new user will be added to the organization, with all the privileges of their shiny new role.

sidebarsFabric.ts

@@ -1,7 +1,49 @@
 import type { SidebarsConfig } from '@docusaurus/plugin-content-docs';
 
 const sidebarsFabric: SidebarsConfig = {
-	fabricSidebar: [{ type: 'autogenerated', dirName: '.' }],
+	fabricSidebar: [
+		{
+			type: 'doc',
+			id: 'index',
+			label: 'Overview',
+		},
+		{
+			type: 'doc',
+			id: 'create-account',
+			label: 'Create Account',
+		},
+		{
+			type: 'doc',
+			id: 'create-organization',
+			label: 'Create Organization',
+		},
+		{
+			type: 'doc',
+			id: 'organization-management',
+			label: 'Organization Management',
+		},
+		{
+			type: 'doc',
+			id: 'cluster-creation-management',
+			label: 'Cluster Creation & Management',
+		},
+		{
+			type: 'doc',
+			id: 'managing-applications',
+			label: 'Managing Applications',
+		},
+		{
+			type: 'doc',
+			id: 'database-management',
+			label: 'Database Management',
+		},
+		{
+			type: 'doc',
+			id: 'logging',
+			label: 'Logging',
+		},
+		{ type: 'autogenerated', dirName: 'fabric' },
+	],
 };
 
 export default sidebarsFabric;

versioned_docs/version-4.6/administration/harper-studio/enable-mixed-content.md

@@ -6,4 +6,22 @@ title: Enable Mixed Content
 
 Enabling mixed content is required in cases where you would like to connect the Harper Studio to Harper Instances via HTTP. This should not be used for production systems, but may be convenient for development and testing purposes. Doing so will allow your browser to reach HTTP traffic, which is considered insecure, through an HTTPS site like the Studio.
 
+Note: If you want to connect insecure HTTP instances from the secure HTTPS Fabric Studio, you can enable mixed content temporarily. This isn't recommended in production systems. It would be better to add HTTPS / SSL Termination in front of your instances. But if you understand the risks, you can enabling mixed content is not recommended for production systems as it can expose users to security risks.
+
+## Steps to Connect to a Self-Hosted Harper Instance
+
+1. Log into [Harper Studio Cloud](https://fabric.harper.fast/).
+2. Select an **organization**.
+3. Click "+ New Cluster" on the top right corner.
+4. In the "New Cluster" page, Fill out the required fields.
+   - Cluster Name - A name for your the cluster.
+   - Harper Deployment - Select "Self-Hosted" (This will allow you to connect to your self-hosted HarperDB instance).
+   - Support & Usage. - Keep the default option "Self Supported and Managed"
+   - Optional Cluster Load Balancer Host Name - This is an optional field. You can leave it blank.
+   - Instance - In the Dropdown, select whether your instance is `HTTP://` or `HTTPS://`. Unsure? Harper Instance by default is set to `HTTPS://` when installed in an instance.
+   - Host Name - The hostname or IP address of your HarperDB instance. Choose `localhost` if you are running the instance on the same machine you're accessing Harper Studio Cloud with.
+   - Port - The port number your HarperDB instance is listening on. Default is `9925`.
+
+5. Click "Create New Cluster". You have now successfully created a new cluster connecting to your local Harper Instance.
+
 A comprehensive guide is provided by Adobe [here](https://experienceleague.adobe.com/docs/target/using/experiences/vec/troubleshoot-composer/mixed-content.html).