Skip to content

Commit

Permalink
GITBOOK-1022: Add settings page review to console docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Scott Carruthers authored and gitbook-bot committed Mar 24, 2023
1 parent c602215 commit 7f65080
Show file tree
Hide file tree
Showing 22 changed files with 120 additions and 38 deletions.
Binary file added .gitbook/assets/akashConsoleActivateCert.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 .gitbook/assets/akashConsoleAnalytics.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 .gitbook/assets/akashConsoleCertCurrent.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 .gitbook/assets/akashConsoleCertInPreflight.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 .gitbook/assets/akashConsoleCertManagement.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 .gitbook/assets/akashConsoleCreateNewCert.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 .gitbook/assets/akashConsoleGenNewCert.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 .gitbook/assets/akashConsoleNewCert.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 .gitbook/assets/akashConsoleNoCert.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 .gitbook/assets/akashConsoleSettingsAccess.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 .gitbook/assets/akashConsoleSettingsOverivew.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 10 additions & 9 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,16 @@
* [Keplr Wallet](tokens-and-wallets/keplr.md)
* [Mixin Messenger for AKT](tokens-and-wallets/mixin-messenger-for-akt.md)
* [Deployments](guides/README.md)
* [Cloudmos Deploy](guides/deploy/README.md)
* [Cloudmos Deploy Access](guides/deploy/cloudmos-deploy-installation.md)
* [Minecraft Deployment Example](guides/deploy/wordpress-deployment-example.md)
* [Manage Deployments](guides/deploy/manage-deployments.md)
* [Custom RPC Node](guides/deploy/custom-rpc-node.md)
* [Akash Console](guides/deploy/README.md)
* [Akash Console Access](guides/deploy/akash-console-access.md)
* [Minesweeper Deployment Example](guides/deploy/minesweeper-deployment-example.md)
* [Deployment Management](guides/deploy/deployment-management.md)
* [Settings](guides/deploy/settings.md)
* [Cloudmos Deploy](guides/cloudmos-deploy/README.md)
* [Cloudmos Deploy Access](guides/cloudmos-deploy/cloudmos-deploy-installation.md)
* [Minecraft Deployment Example](guides/cloudmos-deploy/wordpress-deployment-example.md)
* [Manage Deployments](guides/cloudmos-deploy/manage-deployments.md)
* [Custom RPC Node](guides/cloudmos-deploy/custom-rpc-node.md)
* [CLI](guides/cli/README.md)
* [Detailed Steps](guides/cli/detailed-steps/README.md)
* [Install Akash CLI](guides/cli/detailed-steps/part-1.-install-akash.md)
Expand Down Expand Up @@ -207,10 +212,6 @@
* [Provider Upgrade](mainnet5-upgrade-docs/provider-upgrade.md)
* [Other Resources](other-resources/README.md)
* [Experimental](other-resources/experimental/README.md)
* [Akash Console](other-resources/experimental/akash-console/README.md)
* [Akash Console Access](other-resources/experimental/akash-console/akash-console-access.md)
* [Minesweeper Deployment Example](other-resources/experimental/akash-console/minesweeper-deployment-example.md)
* [Deployment Management](other-resources/experimental/akash-console/deployment-management.md)
* [Akash Provider Streamlined Build with Rancher K3s](other-resources/experimental/akash-provider-streamlined-build-with-rancher-k3s/README.md)
* [STEP 1 - Install K3s and Initial Cluster Config](other-resources/experimental/akash-provider-streamlined-build-with-rancher-k3s/step-1-install-k3s-and-initial-cluster-config.md)
* [STEP 2 - Install Akash CLI](other-resources/experimental/akash-provider-streamlined-build-with-rancher-k3s/step-2-install-akash-cli.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
# Akash Console
# Cloudmos Deploy

## Akash Console Overview
## Cloudmos Deploy Overview

The Akash Console is a web based application which simplifies the deployment process of applications onto the Akash Network. Post deployment the tool provides a dashboard to view the status and details of workloads. The dashboard also has the ability to perform administrative tasks including closing the deployment, updating the deployment, redeploying, and increasing the funding available to the deployment.
Cloudmos Deploy Tool is a web based application which simplifies the deployment process on the Akash Network. Post deployment the tool provides a dashboard to view the status and details of workloads. The dashboard also has the ability to perform administrative tasks including closing the deployment, updating the deployment, redeploying, and increasing the funding available to the deployment.

This guide will cover the following topics:

* [Akash Console Access](akash-console-access.md)
* [Example Access Deployment via Akash Console](minesweeper-deployment-example.md)
* [Deployment Management via Akash Console](deployment-management.md)
* [Cloudmos Deploy Access](cloudmos-deploy-installation.md)
* [Minecraft Deployment Example](wordpress-deployment-example.md)
* [Manage Deployments](manage-deployments.md)
* [Define a custom RPC node](custom-rpc-node.md)

## Akash Wants to Spotlight Your Work
### Akash Wants to Spotlight Your Work

Have an idea for a project to deploy on Akash? Already working on a project? Maybe you’ve already deployed a project (or many projects!) to the network?

Expand Down
File renamed without changes.
File renamed without changes.
16 changes: 8 additions & 8 deletions guides/deploy/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Cloudmos Deploy
# Akash Console

## Cloudmos Deploy Overview
## Akash Console Overview

Cloudmos Deploy Tool is a web based application which simplifies the deployment process on the Akash Network. Post deployment the tool provides a dashboard to view the status and details of workloads. The dashboard also has the ability to perform administrative tasks including closing the deployment, updating the deployment, redeploying, and increasing the funding available to the deployment.
Akash Console is a web based application that makes it easy to deploy applications onto the Akash Network. Post deployment, Akash Console provides a dashboard to view the status and details of workloads. The dashboard also has the ability to perform administrative tasks including closing the deployment, updating the deployment, redeploying, and increasing the funding available to the deployment.

This guide will cover the following topics:

* [Cloudmos Deploy Access](cloudmos-deploy-installation.md)
* [Minecraft Deployment Example](wordpress-deployment-example.md)
* [Manage Deployments](manage-deployments.md)
* [Define a custom RPC node](custom-rpc-node.md)
* [Akash Console Access](akash-console-access.md)
* [Example Access Deployment via Akash Console](minesweeper-deployment-example.md)
* [Deployment Management via Akash Console](deployment-management.md)
* [Settings](settings.md)

### Akash Wants to Spotlight Your Work
## Akash Wants to Spotlight Your Work

Have an idea for a project to deploy on Akash? Already working on a project? Maybe you’ve already deployed a project (or many projects!) to the network?

Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ In this section we will use the Akash Console to launch an example Minesweeper d

From the `New Deployment` page click the `Deploy Now` button in the `Fun & Games` section.

<figure><img src="../../../.gitbook/assets/akashConsoleDeployNow.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/akashConsoleDeployNow.png" alt=""><figcaption></figcaption></figure>

### STEP 2 - Select the Minesweeper Template

Select the `Minesweeper` template and the proceed with the deployment by clicking `Deploy Now`.

<figure><img src="../../../.gitbook/assets/akashConsoleMinecraft.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/akashConsoleMinecraft.png" alt=""><figcaption></figcaption></figure>

### STEP 3 - Assign Deployment Name/Edit SDL

Expand All @@ -24,9 +24,9 @@ Click `Create Deployment` to proceed when satisfied with application naming/set
> \
> \- **Configure services** - allows edit of application specs including CPU, memory, storage, and exposed ports.\
> \
> \- **Review SDL** - allows direct edit of the applications SDL (Stack Description Language) YAML file. Further details on Akash SDL files can be found [here](../../../readme/stack-definition-language.md).
> \- **Review SDL** - allows direct edit of the applications SDL (Stack Description Language) YAML file. Further details on Akash SDL files can be found [here](../../readme/stack-definition-language.md).
<figure><img src="../../../.gitbook/assets/akashConsoleNameDeployment.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/akashConsoleNameDeployment.png" alt=""><figcaption></figcaption></figure>

### STEP 4 - Pre-Flight Verifications

Expand All @@ -36,25 +36,40 @@ Amongst the verifications made are assurances that the connected wallet has suff

If all verifications are successful - as shown in the example below - proceed by clicking the `Next` button.

<figure><img src="../../../.gitbook/assets/akashConsolePreflight.png" alt=""><figcaption></figcaption></figure>
> _**NOTE**_ - if `Wallet Connected` check fails, ensure the `Connect Wallet` step from the [Akash Console Access](akash-console-access.md) section of this document is completed.
### STEP 5 - Accept Gas Fees for Deployment Creation
> _**NOTE**_ - if this is your first time using the Akash Console it is likely the `Valid Certificate` check will fail. Use the instructions in the subsequent step ([STEP 5 - Certificate Creation](minesweeper-deployment-example.md#step-5-certificate-creation)) should this be the case.
<figure><img src="../../.gitbook/assets/akashConsolePreflight.png" alt=""><figcaption></figcaption></figure>

### STEP 5 - Certificate Creation&#x20;

Use the guidance in this step if a valid certificate does not exist.

A valid certificate is necessary to proceed with deployments of apps onto the Akash network. If the `Checking Essentials` screen reports `Missing Certificate` there are two ways to proceed.

* Simply click the `Create Certificate` button presented in the `Checking Essentials` pane as highlighted in the display below. _**NOTE**_ - following the selection of this button it may take a couple of minutes before the `Missing Certificate` warning disappears.
* Manage the Akash Console certificates from the [Settings](settings.md) page. Following the cert creation/activation - as covered in the [Settings](settings.md) documentation - return to the deployment creation process and `Checking Essentials` should no longer display a `Missing Certificate` warning.

<figure><img src="../../.gitbook/assets/akashConsoleCertInPreflight.png" alt=""><figcaption></figcaption></figure>

### STEP 6 - Accept Gas Fees for Deployment Creation

The Keplr wallet will prompt to `Approve` gas fees for the creation of the deployment. Click the `Approve` button to proceed.

Subsequent steps in the Deployment process may also prompt for Gas fee accept. Follow this same step to approve any subsequent such prompts.

<figure><img src="../../../.gitbook/assets/akashConsoleAcceptFees.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/akashConsoleAcceptFees.png" alt=""><figcaption></figcaption></figure>

### STEP 6 - Select Provider
### STEP 7 - Select Provider

Select a preferred Akash Provider for your deployment.

Click the `Submit Deploy Request` button following preferred Provider selection to continue with the deployment.

<figure><img src="../../../.gitbook/assets/akashConsoleProvider.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/akashConsoleProvider.png" alt=""><figcaption></figcaption></figure>

### STEP 7 - Deployment Complete
### STEP 8 - Deployment Complete

Upon successful completion of the Akash Deployment the following screen is presented.

Expand All @@ -65,14 +80,14 @@ The Deployment management pane allows actions including:
* _**LEASES**_ - review of the deployment's specifications including exposed ports and assigned resources
* _**Update/Delete Deployment**_ - ability to manage the active deployment by updating application image or closing the deployment.

<figure><img src="../../../.gitbook/assets/akashConsoleDeploymentComplete.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/akashConsoleDeploymentComplete.png" alt=""><figcaption></figcaption></figure>

### STEP 8 - Access Deployment
### STEP 9 - Access Deployment

Access the Deployment's URL via the exposed link.

<figure><img src="../../../.gitbook/assets/akashConsoleURL.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/akashConsoleURL.png" alt=""><figcaption></figcaption></figure>

Example display of the Minesweeper web app within the Akash Deployment.

<figure><img src="../../../.gitbook/assets/akashConsoleAccess.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/akashConsoleAccess.png" alt=""><figcaption></figcaption></figure>
65 changes: 65 additions & 0 deletions guides/deploy/settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Settings

The Akash Console Settings page is used primarily for certificate management. This guide describes cert management and other activities available from the Settings page.

### Settings Access

The Akash Console Settings page can be accessed from the left-hand navigation bar and from any page within the app.

<figure><img src="../../.gitbook/assets/akashConsoleSettingsAccess.png" alt=""><figcaption></figcaption></figure>

### Settings Overview

The Akash Console Settings page currently allows three types of actions. Drill into the link for each action type for additional detail.

* [Generate New Cert](settings.md#generate-new-cert)
* [Certificate Management](settings.md#certificate-management)
* [Analytics Opt In](settings.md#analytics-opt-in)

<figure><img src="../../.gitbook/assets/akashConsoleSettingsOverivew.png" alt=""><figcaption></figcaption></figure>

### Generate New Cert

The primary activity in the Settings page involves certificate management. A valid, active certificate must exist to proceed with Akash deployment activities (create deployment, delete deployment, etc).

If no certificate currently exists the Akash Console displays the message - `You don't have any certificates. You must generate a new certificate to deploy.` - as per example below.

Follow the steps in the remainder of this section to create a new certificate when necessary.

<figure><img src="../../.gitbook/assets/akashConsoleNoCert.png" alt=""><figcaption></figcaption></figure>

Click the `Generate New Cert` button to begin the process of new certificate creation.

<figure><img src="../../.gitbook/assets/akashConsoleCreateNewCert.png" alt=""><figcaption></figcaption></figure>

Click the `Create` button to proceed with new certificate creation.

<figure><img src="../../.gitbook/assets/akashConsoleNewCert.png" alt=""><figcaption></figcaption></figure>

Following successful certificate creation, click the `ACTIVATE` option.

<figure><img src="../../.gitbook/assets/akashConsoleActivateCert.png" alt=""><figcaption></figcaption></figure>

Following certificate creation and activation a `Current` status should display.

If the `Settings` page now list the newly created certificate with a status of `Current` - you should be all set to proceed with Akash deployment creations and management within the Console.

<figure><img src="../../.gitbook/assets/akashConsoleCertCurrent.png" alt=""><figcaption></figcaption></figure>

### Certificate Management

The Settings page can be used for certificate management purposes.&#x20;

When several certificates exist for the current account - as selected in Keplr - use the available management actions to activate a specific cert if needed.

We can additionally use the certificate management pane to determine what certificate is currently active and revoke certificates if desired.

<figure><img src="../../.gitbook/assets/akashConsoleCertManagement.png" alt=""><figcaption></figcaption></figure>

### Analytics Opt In

The Akash Console development team utilizes analytics received from the application to improve usability and performance. By default Analytics are enabled (`Opted-In` is active) meaning statistics from your browser will be collected and sent to the Akash team. No private information is stored or sent as part of this analytics collection.

To change the status of Analytics Opt In use the toggle highlighted below.

<figure><img src="../../.gitbook/assets/akashConsoleAnalytics.png" alt=""><figcaption></figcaption></figure>

0 comments on commit 7f65080

Please sign in to comment.