Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/architecture/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Architecture",
"position": 6
"position": 8
}
3 changes: 2 additions & 1 deletion docs/architecture/assets/components.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 7 additions & 1 deletion docs/architecture/e2e-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,18 @@ OCF manifests are stored in [Hub](#hub).

### CLI

CLI is command line tool which makes easier with working the [OCF](#ocf) manifests and Actions.
CLI is command line tool which makes easier to manage [OCF](#ocf) manifests and Actions.

To read the documentation about CLI tool, see the [Getting started](../cli/getting-started.mdx) document.

CLI utilizes [SDK](#sdk).

### Dashboard

Dashboard is a web-based user interface for managing Capact resources, such as Actions.

To read more about Dashboard, see the [Overview](../dashboard-ui/overview.md) document.

### Gateway

Gateway is a GraphQL reverse proxy. It aggregates multiple remote GraphQL schemas into a single endpoint. It enables [CLI](#cli) and other clients to have a single destination for all GraphQL operations.
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "CLI",
"position": 7
"position": 6
}
6 changes: 5 additions & 1 deletion docs/cli/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 1

# Getting Started

In addition to a Capact GraphQL API, Capact features a command-line interface that wraps common functionality and formats output. The Capact CLI is a single static binary. It is a wrapper around the Capact GraphQL API and Kubernetes API.
Capact features a command-line interface that wraps common functionality and formats output. The Capact CLI is a single static binary. It is a wrapper around the Capact GraphQL API and Kubernetes API.

## Install

Expand Down Expand Up @@ -272,3 +272,7 @@ Use the `CAPACT_CREDENTIALS_STORE_BACKEND` environment variable to change the de
## Next steps

✨ After setting up Capact CLI, you are ready to start a journey with the Capact project. Check out our [Mattermost installation example](../example/mattermost-installation.md) to learn how to use Capact CLI to provision an example application.

## See also

If you would rather manage Capact resources using UI, read the [Dashboard Overview](../dashboard-ui/overview.md) document.
2 changes: 1 addition & 1 deletion docs/content-development/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Content development",
"position": 5
"position": 8
}
4 changes: 4 additions & 0 deletions docs/dashboard-ui/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Dashboard UI",
"position": 7
}
86 changes: 86 additions & 0 deletions docs/dashboard-ui/action-management.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
# Action management

This document describes how to manage Actions from the Capact Dashboard UI.

## Prerequisites

- Cluster with Capact installation. See the [installation](../installation/local.mdx) tutorial.
- An user logged in Dashboard. See the [Getting started](./overview.md#) guide.

## Create Action

1. Click on the **Hub** section on the left-side menu.

You will see all InterfaceGroups available in the Hub.

![InterfaceGroups](./assets/hub-interfacegroups.png)

Click on one of the InterfaceGroups tiles, for example **PostgreSQL**.

1. See the list of all Interfaces within a given InterfaceGroup.

![Interfaces](./assets/hub-interfaces.png)

- You can toggle list/card view using the icons (1) on the right top side.
- Create Action for a given Interface using the **Create Action** link (2).

1. If the selected Interface requires input parameters, you will be asked to provide them.

![InputParameters](./assets/action-create-params.png)

Fill the form with input parameters for Interface, and click **Next**.

1. If the selected Interface requires input TypeInstances, you will be asked to provide them.

![TypeInstances](./assets/action-create-tis.png)

Provide all required input TypeInstances and click **Next**.

1. Verify the Action details on the Action Summary.

![Summary](./assets/action-create-summary.png)

- To edit Action name, click on the pen icon (1) next to the generated Action name.
- Switch to **Advanced Settings** (2) tab, to optionally select a specific Implementation and provide Implementation-specific input if needed.
- To create the Action, click the **Submit** button (3).

## List Actions

To see the list of Actions, navigate to the **Actions** section on the left-side menu.
You can sort Actions by a given table column by clicking on the specific table header.

![Action List](./assets/action-list.png)

## Manage single Action

To see the details of a single Action, navigate to the **Actions** section on the left-side menu, and click either on the Action name or the eye icon:

![Action Details Navigation](./assets/action-details-navigation.png)

Then you will be navigated to the Action details view, where you can display all data about a given Action - including rendered workflow, inputs and outputs.

![Action Details view](./assets/action-details.png)

### Run Action

To run a given Action, click the **Run** button. The button is enabled only if Action is runnable, that is, in the "Ready to Run" state.

![Action run](./assets/action-details-buttons.png)

### See Action workflow

1. To be able to use Argo Workflows UI link in the Action details view, make the Argo Workflows UI accessible with the following command:

```bash
kubectl -n capact-system port-forward svc/argo-argo-workflows-server 2746
```

1. To see the Action workflow, switch to the **Workflow** tab in Action details view, and click the **See workflow in Argo UI** button. The button is clickable only if Action has been already run.

![Action Argo workflow](./assets/action-details-argo-workflow.png)

### Delete Action

To delete a given Action, click the **Delete** button. Click **Yes** button in the confirmation tooltip.

![Action delete](./assets/action-details-buttons.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/dashboard-ui/assets/action-create-tis.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/dashboard-ui/assets/action-details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/dashboard-ui/assets/action-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/dashboard-ui/assets/hub-interfacegroups.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/dashboard-ui/assets/hub-interfaces.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/dashboard-ui/assets/login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
57 changes: 57 additions & 0 deletions docs/dashboard-ui/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
sidebar_position: 1
---

# Overview

Dashboard is a convenient, web-based UI for managing Capact resources. It comes as a built-in Capact component, enabled by default.

> **NOTE:** Capact Dashboard is still at an early stage of development and has a basic set of features. Over time it will become more powerful, and our documentation will be updated to describe how it can be used as an alternative for CLI.

## Prerequisites

- Cluster with Capact installation. See the [installation tutorial](../installation/local.mdx).

## Get started

1. Get credentials for login to the Capact Dashboard.

Run the following command to obtain and print user credentials:

```bash
export GATEWAY_USER=$(kubectl -n capact-system get secret capact-gateway -ogo-template='{{.data.username | base64decode }}')
export GATEWAY_PASS=$(kubectl -n capact-system get secret capact-gateway -ogo-template='{{.data.password | base64decode }}')
print "Username: ${GATEWAY_USER}\nPassword: ${GATEWAY_PASS}"
```

Note the output of this command.

1. Navigate to the `https://dashboard.{domain}` URL, where the `{domain}` is the domain used for Capact installation.

For example, for local installation, the Dashboard URL is `https://dashboard.capact.local`.

1. You will see Capact Dashboard login form.

![Login form](./assets/login.png)

Use the credentials from the first step of this instruction to log in.

1. As now you are logged in, you are ready to explore the Capact Dashboard features!

![Hub](./assets/hub-interfacegroups.png)

## Advanced configuration

You can configure Capact Dashboard in runtime, by editing ConfigMap:

```bash
kubectl edit configmap -n capact-system capact-dashboard-runtime-cfg
```

To read possible configuration options, see the [Configuration](https://github.com/capactio/dashboard#configuration) section in Dashboard Readme.

Currently, these settings won't be preserved between Capact installation upgrades.

## See also

If you would rather manage Capact resources with CLI tool, read the [Getting started](../cli/getting-started.mdx) document. As Capact CLI is more mature, currently it is packed with more features.
2 changes: 1 addition & 1 deletion docs/operation/_category_.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"label": "Operations",
"position": 8
"position": 9
}
3 changes: 2 additions & 1 deletion hack/make-release.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ release::generate_docs() {
local -r version="$1"

npm run docusaurus docs:version "${version}"
sed -i.bak -E "s|...generateDocsRedirectsForVersion\(\"(.+)\", true\)|...generateDocsRedirectsForVersion(\"\1\"),\n ...generateDocsRedirectsForVersion(\"${version}\", true)|" "./redirects.js"
sed -i.bak -E "s|const versions = \[|const versions = \[\n \"${version}\",|" "./redirects.js"
sed -i.bak -E "s|next: true,|${version}: true,\n next: true,|" "./redirects.js"
}

release::update_binary_links() {
Expand Down
Loading