diff --git a/SUMMARY.md b/SUMMARY.md index 606e9744..47aafe2a 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -231,21 +231,3 @@ * [Kubernetes Cluster](other-resources/archived-resources/build-a-cloud-provider/kubernetes-cluster.md) * [gVisor Issue - No system-cgroup v2 Support](other-resources/archived-resources/build-a-cloud-provider/gvisor-issue-no-system-cgroup-v2-support.md) * [Provider Networks](other-resources/archived-resources/build-a-cloud-provider/provider-networks.md) - * [Mainnet3 Legacy Docs](other-resources/archived-resources/mainnet3-legacy-docs/README.md) - * [Detailed Steps](other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/README.md) - * [Install Akash CLI](other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-1.-install-akash.md) - * [Create an Account](other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-2.-create-an-account.md) - * [Fund your Account](other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-3.-fund-your-account.md) - * [Configure your Network](other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-4.-configure-your-network.md) - * [Create your Configuration](other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-5.-create-your-configuration.md) - * [Create your Certificate](other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-6.-create-your-certificate.md) - * [Create your Deployment](other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-7.-create-your-deployment.md) - * [View your Bids](other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-8.-view-your-bids.md) - * [Create a Lease](other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-9.-create-a-lease.md) - * [Send the Manifest](other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-10.-send-the-manifest.md) - * [Update the Deployment](other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-11.-update-the-deployment.md) - * [Close Deployment](other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/close-deployment.md) - * [Install Akash](other-resources/archived-resources/mainnet3-legacy-docs/install.md) - * [Setup your Environment](other-resources/archived-resources/mainnet3-legacy-docs/shell-variables.md) - * [Create Your Account](other-resources/archived-resources/mainnet3-legacy-docs/wallet.md) - * [Akash Provider Migration Guide - 0.14.X to 0.16.3](other-resources/archived-resources/akash-provider-migration-guide-0.14.x-to-0.16.3.md) diff --git a/other-resources/archived-resources/akash-provider-migration-guide-0.14.x-to-0.16.3.md b/other-resources/archived-resources/akash-provider-migration-guide-0.14.x-to-0.16.3.md deleted file mode 100644 index 7fe62e0b..00000000 --- a/other-resources/archived-resources/akash-provider-migration-guide-0.14.x-to-0.16.3.md +++ /dev/null @@ -1,227 +0,0 @@ ---- -description: v0.14.x to v0.16.3 ---- - -# Akash Provider Migration Guide - 0.14.X to 0.16.3 - -Akash version 0.16.3 will introduce changes in CRDs that need to be applied in order to continue operations. - -All steps below MUST be executed in the same order as declared and applied to your environment. If any step fails STOP and reach out to the Akash team. - -## Precursor to Upgrade - Orphan Manifest Purge - -### Create Script File - -``` -cd ~ - -vi manifest-purge.sh -``` - -### Populate Script File - -``` -#!/usr/bin/env bash - -kubectl get mani -n lease -o 'custom-columns=name:{.metadata.name}' --no-headers | \ - while read ns; do - - # if ns exists, it's a fresh manifest. - if kubectl get ns "$ns" >/dev/null 2>&1; then - echo "FOUND: $ns" - continue - fi - - # make sure it's a NotFound error before deleting. - nserr=$(kubectl get ns "$ns" 2>&1) - if [[ "$nserr" == *NotFound* ]]; then - echo "GONE: $ns" - kubectl delete mani "$ns" -n lease - continue - fi - done -``` - -### Make Script Executable - -``` -chmod +x ~/manifest-purge.sh -``` - -### Execute Script - -``` -./manifest-purge.sh -``` - -## Provider Service Running on Bare Metal/VM - -### STEP 1 - Upgrade RPC node to 0.16.3 - -If you are using 3rd-party RPC node ensure upgrade has been applied. - -If you are using your own RPC node - as recommended for Providers - ensure the node has been upgraded. - -### STEP 2 - Stop provider service - -The Akash Provider service is most likely controlled by systemd and if so can be stopped as shown below - -``` -systemctl stop akash-provider -``` - -### STEP 3 - Upgrade Akash Version - -Download and extract the v0.16.3 from under the Assets drop-down menu here https://github.com/ovrclk/akash/releases/tag/v0.16.3 for your OS & Architecture. - -Replace the old akash binary with the new one. - -### STEP 4 - Ensure Akash Client Upgrade - -#### Verify Version and Expected Output - -``` -root@ip-10-0-10-125:/home/ubuntu# akash version - -v0.16.3 -``` - -### **STEP 5 - Download v0.16.3 Provider CRDs** - -``` -wget https://raw.githubusercontent.com/ovrclk/akash/mainnet/main/pkg/apis/akash.network/crd.yaml -``` - -### **STEP 6 - Install v0.16.3 CRDs** - -``` -akash provider migrate v0.14tov0.16 --crd ./crd.yaml -``` - -#### **Expected Output from Upgrade** - -``` -root@ip-10-0-10-125:~# akash provider migrate v0.14tov0.16 --crd ./crd.yaml - -using kube config file /root/.kube/config -checking manifests to backup -checking providers hosts to backup -total to backup - manifests: 1 - provider hosts: 1 -backup manifests -backup manifests DONE -backup provider hosts -backup provider hosts DONE -applying CRDs -customresourcedefinition.apiextensions.k8s.io "manifests.akash.network" deleted -customresourcedefinition.apiextensions.k8s.io "providerhosts.akash.network" deleted -customresourcedefinition.apiextensions.k8s.io/manifests.akash.network created -customresourcedefinition.apiextensions.k8s.io/providerhosts.akash.network created -applying CRDs DONE -applying manifests -manifest "mbamrdgl7ser2f253ubem42r074vsi6aj6c6a4bldfgq4" has been migrated successfully -applying manifests DONE -applying hosts -provider host "c5o7gdvuodea90sgpm7v3rt0d0.ingress.akashtesting.xyz" has been migrated successfully -applying hosts DONE -``` - -### STEP 7 - Start provider service - -#### Using SystemD - -``` -systemctl start akash-provider -``` - -### STEP 8 - Create the Hostname Operator Service - -``` -cat /etc/systemd/system/akash-hostname-operator.service -[Unit] -Description=Akash Hostname Operator -After=network.target - -[Service] -User=akash -Group=akash -ExecStart=akash provider hostname-operator -KillSignal=SIGINT -Restart=on-failure -RestartSec=15 -StartLimitInterval=200 -StartLimitBurst=10 -#LimitNOFILE=65535 - -[Install] -WantedBy=multi-user.target -``` - -### STEP 9 - Start the Hostname Operator Service - - - -``` -systemctl start akash-hostname-operator -systemctl enable akash-hostname-operator -``` - -### STEP 10 - Check Status of Provider - -* Make a test deployment and ensure the DSEQ hits provider logs and that you can create deployment/lease and send manifest - -``` -journalctl -u akash-provider --since '5 min ago' -f -``` - -## **Provider Service Running in Kubernetes via Helm Charts** - -If you are using Helm Charts for installing the Akash Provider and wishing to upgrade to 0.16.3, then run the same commands you have previously used with adding --set image.tag="0.16.3" on the command line like in the example below. - -### STEP 1 - Upgrade RPC node to 0.16.3 - -If you are using a 3rd-party RPC node ensure upgrade has been applied. - -If you are using your own RPC node - as recommended for Providers - ensure the node has been upgraded. - -### **STEP2 - Upgrade Provider** - -#### Scale Provider Down to Zero During Update - -``` -kubectl scale deploy -n akash-services akash-provider --replicas=0 -``` - -**Update Current CRDs** - -``` -kubectl apply --server-side -f https://raw.githubusercontent.com/ovrclk/helm-charts/main/charts/akash-provider/templates/crds.yaml -``` - -#### Add/Update the Helm Repo - -``` -helm repo add akash https://ovrclk.github.io/helm-charts -helm repo update -``` - -#### Perform the Upgrade - -``` -helm upgrade akash-node akash/akash-node -n akash-services ... --set image.tag="0.16.3" - -helm upgrade akash-provider akash/provider -n akash-services ... --set image.tag="0.16.3" - -helm upgrade hostname-operator akash/hostname-operator -n akash-services ... --set image.tag="0.16.3" -``` - -#### Scale Provider Back Up Post Update - -``` -kubectl scale deploy -n akash-services akash-provider --replicas=1 -``` - -## Additional Notes - -Migrate command creates a directory to backup kubernetes objects. By default it is the current directory. It can be changed with --k8s-crd-migrate-path flag Directory content is preserved after success. Delete it IF and ONLY IF migration has been successful. diff --git a/other-resources/archived-resources/mainnet3-legacy-docs/README.md b/other-resources/archived-resources/mainnet3-legacy-docs/README.md deleted file mode 100644 index 0f1ff21c..00000000 --- a/other-resources/archived-resources/mainnet3-legacy-docs/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# Mainnet3 Legacy Docs - diff --git a/other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/README.md b/other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/README.md deleted file mode 100644 index b773267f..00000000 --- a/other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/README.md +++ /dev/null @@ -1,30 +0,0 @@ -# Detailed Steps - -Explore detailed steps and options of the Akash CLI. In this guide we will define each environment variable and use within each command. - -If you desire an easier way to get started with the Akash CLI, consider our [Streamlined Steps ](../../../experimental/streamlined-steps/)documentation. - -### 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? - -We love seeing what our community is building. Once your deployment is live, head over to our Discord and share the details of your app in our [Deployments channel](https://discord.com/channels/747885925232672829/771909909335506955) and tag @Admin. - -Once you share your app, someone from the Akash team may reach out to spotlight your app across our newsletter, blog, and social media. - -This is a great opportunity to connect with the team at Akash Network and to spotlight your work for our world-class community. - -### Overview of Verbose Steps - -* [Install Akash](part-1.-install-akash.md) -* [Create an Account](part-2.-create-an-account.md) -* [Fund your Account](part-3.-fund-your-account.md) -* [Configure your Network](part-4.-configure-your-network.md) -* [Create your Configuration](part-5.-create-your-configuration.md) -* [Create your Certificate](part-6.-create-your-certificate.md) -* [Create your Deployment](part-7.-create-your-deployment.md) -* [View your Bids](part-8.-view-your-bids.md) -* [Create a Lease](part-9.-create-a-lease.md) -* [Send the Manifest](part-10.-send-the-manifest.md) -* [Update the Deployment](part-11.-update-the-deployment.md) -* [Close Deployment](close-deployment.md) diff --git a/other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/close-deployment.md b/other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/close-deployment.md deleted file mode 100644 index f6a216c7..00000000 --- a/other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/close-deployment.md +++ /dev/null @@ -1,10 +0,0 @@ -# Close Deployment - -### Close the Deployment - -Should you need to close the deployment follow this step. - -``` -akash tx deployment close --from $AKASH_KEY_NAME -``` - diff --git a/other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-1.-install-akash.md b/other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-1.-install-akash.md deleted file mode 100644 index 15494e05..00000000 --- a/other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-1.-install-akash.md +++ /dev/null @@ -1,143 +0,0 @@ -# Install Akash CLI - -Select a tab below to view instructions for MacOS, Linux, or compiling from source. - -{% tabs %} -{% tab title="MacOS" %} -### MacOS - -The simplest way to install Akash is using Homebrew using: - -``` -brew install ovrclk/tap/akash -``` - -If you do not have homebrew, follow the below steps for installing the Akash Binary. - -#### Download Akash Binary - -These commands will retrieve the latest, stable version of the Akash software, store the version in a local variable, and install that version. - -``` -cd ~/Downloads - -AKASH_VERSION="$(curl -s "https://raw.githubusercontent.com/ovrclk/net/master/mainnet/version.txt")" - -curl https://raw.githubusercontent.com/ovrclk/akash/master/godownloader.sh | sh -s -- "v$AKASH_VERSION" -``` - -#### Move the Akash Binary - -Move the binary file into a directory included in your path - -``` -sudo mv ./bin/akash /usr/local/bin -``` - -#### Verify Akash Installation - -Verify the installation by using a simple command to check the Akash version - -``` -akash version -``` - -Expect/Example Output - -``` -v0.16.3 -``` -{% endtab %} - -{% tab title="Linux" %} -### Linux - -The simplest way to install Akash is using Homebrew using: - -``` -brew install ovrclk/tap/akash -``` - -If you do not have homebrew, follow the below steps for installing the Akash Binary. - -#### Download Akash Binary - -These commands will retrieve the latest, stable version of the Akash software\_**,**\_ store the version in a local variable, and install that version. - -``` -cd ~ - -AKASH_VERSION="$(curl -s "https://raw.githubusercontent.com/ovrclk/net/master/mainnet/version.txt")" - -curl https://raw.githubusercontent.com/ovrclk/akash/master/godownloader.sh | sh -s -- "v$AKASH_VERSION" -``` - -#### Add Akash Install Location to User’s Path - -Add the software’s install location to the user’s path for easy use of Akash commands. - -**NOTE:** Below we provide the steps to add the Akash install directory to a user’s path on a Linux Ubuntu server. Please take a look at a guide for your operating system and how to add a directory to a user’s path. - -Open the user’s path file in an editor: - -``` -vi /etc/environment -``` - -View within text editor prior to the update: - -``` -PATH="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin" -``` - -Add the following directory, which is the Akash install location, to `PATH`. In this example the active user is root. If logged in as another username, replace /root with your current/home directory. - -``` -/root/bin -``` - -View within the text editor following the update: - -``` -PATH="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin:/root/bin" -``` - -### Make the Path Active in the Current Session - -``` -source /etc/environment -``` - -### Verify Akash Install - -Display the version of Akash software installed. This confirms the software installed and that the new user path addition worked. - -``` -akash version -``` - -Expected/Example Result - -``` -v0.16.3 -``` -{% endtab %} - -{% tab title="Source" %} -### From Source - -Installing Akash suite from source: - -``` -$ go get -d github.com/ovrclk/akash -$ cd $GOPATH/src/github.com/ovrclk/akash -$ git checkout "v$AKASH_VERSION" -$ make deps-install -$ make install -``` - -Akash is developed and tested with [golang 1.16+](https://golang.org/). Building requires a working [golang](https://golang.org/) installation, a properly set `GOPATH`, and `$GOPATH/bin` present in `$PATH`. - -Once you have the dependencies properly setup, download and build `akash` using `make install` -{% endtab %} -{% endtabs %} diff --git a/other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-10.-send-the-manifest.md b/other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-10.-send-the-manifest.md deleted file mode 100644 index adb513fc..00000000 --- a/other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-10.-send-the-manifest.md +++ /dev/null @@ -1,51 +0,0 @@ -# Send the Manifest - -Upload the manifest using the values from above step: - -``` -akash provider send-manifest deploy.yml --dseq $AKASH_DSEQ --provider $AKASH_PROVIDER --from $AKASH_KEY_NAME -``` - -### Confirm the URL - -Now that the manifest is uploaded, your image is deployed. You can retrieve the access details by running the below: - -``` -akash provider lease-status --dseq $AKASH_DSEQ --from $AKASH_KEY_NAME --provider $AKASH_PROVIDER -``` - -You should see a response similar to: - -```javascript -{ - "services": { - "web": { - "name": "web", - "available": 1, - "total": 1, - "uris": [ - "rga3h05jetf9h3p6dbk62m19ck.ingress.ewr1p0.mainnet.akashian.io" - ], - "observed_generation": 1, - "replicas": 1, - "updated_replicas": 1, - "ready_replicas": 1, - "available_replicas": 1 - } - }, - "forwarded_ports": {} -} -``` - -You can access the application by visiting the hostnames mapped to your deployment. Look for a URL/URI and copy it to your web browser. - -### View your logs - -You can view your application logs to debug issues or watch progress like so: - -```bash -akash provider lease-logs \ - --dseq "$AKASH_DSEQ" \ - --provider "$AKASH_PROVIDER" \ - --from "$AKASH_KEY_NAME" -``` diff --git a/other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-11.-update-the-deployment.md b/other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-11.-update-the-deployment.md deleted file mode 100644 index 3b51bac4..00000000 --- a/other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-11.-update-the-deployment.md +++ /dev/null @@ -1,19 +0,0 @@ -# Update the Deployment - -### Update the Manifest - -Update the deploy.yml manifest file with the desired change. - -_**NOTE:**_\*\* Not all attributes of the manifest file are eligible for deployment update. If the hardware specs of the manifest are updated (I.e. CPU count), a re-deployment of the workload is necessary. Other attributes, such as deployment image and funding, are eligible for updates. - -### Issue Transaction for On Chain Update - -``` -akash tx deployment update deploy.yml --dseq $AKASH_DSEQ --from $AKASH_KEY_NAME -``` - -### Send Updated Manifest to Provider - -``` -akash provider send-manifest deploy.yml --dseq $AKASH_DSEQ --provider $AKASH_PROVIDER --from $AKASH_KEY_NAME -``` diff --git a/other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-2.-create-an-account.md b/other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-2.-create-an-account.md deleted file mode 100644 index 38f91ad4..00000000 --- a/other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-2.-create-an-account.md +++ /dev/null @@ -1,35 +0,0 @@ -# Create an Account - -Configure the name of your key. The command below will set the name of your key to `myWallet`, run the below command and replace `myWallet` with a name of your choice: - -```bash -AKASH_KEY_NAME=myWallet -``` - -Verify you have the shell variables set up . The below command should return the name you've used: - -```bash -echo $AKASH_KEY_NAME -``` - -We now need to point Akash to where the keys are stored for your configuration. To do this we will set the AKASH\_KEYRING\_BACKEND environmental variable. - -```bash -AKASH_KEYRING_BACKEND=os -``` - -Copy and paste this command into Terminal to create an Akash account: - -```bash -akash keys add $AKASH_KEY_NAME -``` - -Read the output and save your mnemonic phrase is a safe place. Let's set a Shell Variable in Terminal `AKASH_ACCOUNT_ADDRESS` to save your account address for later. - -```bash -export AKASH_ACCOUNT_ADDRESS="$(akash keys show $AKASH_KEY_NAME -a)" - -echo $AKASH_ACCOUNT_ADDRESS -``` - -Note that if you close your Terminal window this variable will not be saved. diff --git a/other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-3.-fund-your-account.md b/other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-3.-fund-your-account.md deleted file mode 100644 index 1827e216..00000000 --- a/other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-3.-fund-your-account.md +++ /dev/null @@ -1,6 +0,0 @@ -# Fund your Account - -A minimum deposit of 5 AKT is required to deploy on Akash, and a small transaction fee is applied to deployment leases paid by the account used to deploy. There are two ways to get funds into your account, buy tokens, and join the Akash community to receive free tokens from the Akash Faucet. - -* [Buy AKT from an exchange](../../../../token/buy.md) -* [Join the Akash Community to get free AKT](../../../../token/funding.md) diff --git a/other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-4.-configure-your-network.md b/other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-4.-configure-your-network.md deleted file mode 100644 index 67396c9d..00000000 --- a/other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-4.-configure-your-network.md +++ /dev/null @@ -1,88 +0,0 @@ -# Configure your Network - -First configure the base URL (`$AKASH_NET`) for the Akash Network; copy and paste the command below: - -```bash -AKASH_NET="https://raw.githubusercontent.com/ovrclk/net/master/mainnet" -``` - -## Version - -Next configure the version of the Akash Network `AKASH_VERSION`; copy and paste the command below: - -```bash -AKASH_VERSION="$(curl -s "$AKASH_NET/version.txt")" -``` - -## Chain ID - -The akash CLI will recogonize `AKASH_CHAIN_ID` environment variable when exported to the shell. - -```bash -export AKASH_CHAIN_ID="$(curl -s "$AKASH_NET/chain-id.txt")" -``` - -## Network Node - -You need to select a node on the network to connect to, using an RPC endpoint. To configure the`AKASH_NODE` environment variable use this export command: - -```bash -export AKASH_NODE="$(curl -s "$AKASH_NET/rpc-nodes.txt" | shuf -n 1)" -``` - -## Confirm your network variables are setup - -Your values may differ depending on the network you're connecting to. - -```bash -echo $AKASH_NODE $AKASH_CHAIN_ID $AKASH_KEYRING_BACKEND -``` - -You should see something similar to: - -`http://135.181.60.250:26657 akashnet-2 os` - -## Set Additional Environment Variables - -Set the below set of environment variables to ensure smooth operations - -| Variable | Description | Recommended Value | -| ---------------------- | ----------------------------------------------------------------------------------------- | ----------------- | -| AKASH\_GAS | Gas limit to set per-transaction; set to "auto" to calculate sufficient gas automatically | `auto` | -| AKASH\_GAS\_ADJUSTMENT | Adjustment factor to be multiplied against the estimate returned by the tx simulation | `1.15` | -| AKASH\_GAS\_PRICES | Gas prices in decimal format to determine the transaction fee | `0.025uakt` | -| AKASH\_SIGN\_MODE | Signature mode | `amino-json` | -| AKASH\_CHAIN\_ID | The network chain ID | `akashnet-2` | - -``` -export AKASH_GAS=auto -export AKASH_GAS_ADJUSTMENT=1.25 -export AKASH_GAS_PRICES=0.025uakt -export AKASH_CHAIN_ID=akashnet-2 -export AKASH_SIGN_MODE=amino-json -``` - -## Check your Account Balance - -Check your account has sufficient balance by running: - -```bash -akash query bank balances --node $AKASH_NODE $AKASH_ACCOUNT_ADDRESS -``` - -You should see a response similar to: - -``` -balances: -- amount: "93000637" - denom: uakt -pagination: - next_key: null - total: "0" -``` - -If you don't have a balance, please see the [funding guide](https://github.com/ovrclk/docs/tree/b65f668b212ad1976fb976ad84a9104a9af29770/guides/wallet/funding.md). Please note the balance indicated is denominated in uAKT (AKT x 10^-6), in the above example, the account has a balance of _93 AKT_. We're now setup to deploy. - -{% hint style="info" %} -Your account must have a minimum balance of 5 AKT to create a deployment. This 5 AKT funds the escrow account associated with the deployment and is used to pay the provider for their services. It is recommended you have more than this minimum balance to pay for transaction fees. For more information on escrow accounts, see [here](../../../../guides/cli/detailed-steps/broken-reference/) -{% endhint %} diff --git a/other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-5.-create-your-configuration.md b/other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-5.-create-your-configuration.md deleted file mode 100644 index 16f08e4a..00000000 --- a/other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-5.-create-your-configuration.md +++ /dev/null @@ -1,60 +0,0 @@ -# Create your Configuration - -Create a deployment configuration [deploy.yaml](https://github.com/ovrclk/docs/tree/b65f668b212ad1976fb976ad84a9104a9af29770/guides/deploy/deploy.yml) to deploy the `ovrclk/lunie-light` for [Lunie Light](https://github.com/ovrclk/lunie-light) Node app container using [SDL](https://github.com/ovrclk/docs/tree/b65f668b212ad1976fb976ad84a9104a9af29770/sdl/README.md). - -You can use cURL to download the file: - -``` -curl -s https://raw.githubusercontent.com/ovrclk/docs/master/guides/deploy/deploy.yml > deploy.yml -``` - -### Modify your Configuration - -You may use the sample deployment file as-is or modify it for your own needs as described in our [SDL (Stack Definition Language)](../../../../sdl/) documentation. A typical modification would be to reference your own image instead of our demo app image. - -#### EXAMPLE CONFIGURATION: - -```bash -cat > deploy.yaml <- - This guide walks through installing and using all components of Akash - software. ---- - -# Install Akash - -The software to run **Akash** and the command-line client used to interact with them are all distributed in the `akash`application. The `akash` command is used to run the Akash Network. - -Select a tab below to view instructions for MacOS, Linux, or compiling from source. - -{% tabs %} -{% tab title="MacOS" %} -## MacOS - -### 1. Download and Install Akash - -* These commands will retrieve the latest, stable version of the Akash software, store the version in a local variable, and install that version. - -``` -cd ~/Downloads - -AKASH_VERSION="$(curl -s "https://raw.githubusercontent.com/ovrclk/net/master/mainnet/version.txt")" - -curl https://raw.githubusercontent.com/ovrclk/akash/master/godownloader.sh | sh -s -- "v$AKASH_VERSION" -``` - -### 2. Move the Akash Binary - -* Move the binary file into a directory included in your path - -``` -sudo mv ./bin/akash /usr/local/bin -``` - -### 3. Verify Akash Installation - -* Verify the installation by using a simple command to check the Akash version - -``` -akash version -``` - -* Expect/Example Output - -``` -akash version - -v0.16.3 -``` -{% endtab %} - -{% tab title="Linux" %} -### Linux - -Download the archive for your system from the [release page](https://github.com/ovrclk/akash/releases), extract it, and install the `akash` binary into your path. - -**GoDownloader** - -Alternatively, install the latest version via [`godownloader`](https://github.com/goreleaser/godownloader) First, configure the version of the Akash Network `AKASH_VERSION`as a shell variable in your terminal: - -```bash -# configure akash version -AKASH_VERSION="$(curl -s "https://raw.githubusercontent.com/ovrclk/net/master/mainnet/version.txt")" - -# install akash -curl https://raw.githubusercontent.com/ovrclk/akash/master/godownloader.sh | sh -s -- "v$AKASH_VERSION" -``` - -The final step is to make sure that the akash binaries are available in your shell `PATH`. [This page](https://stackoverflow.com/questions/14637979/how-to-permanently-set-path-on-linux-unix) contains instructions for setting the PATH on Linux. -{% endtab %} - -{% tab title="Source" %} -### Source - -Installing Akash suite from source - -``` -$ go get -d github.com/ovrclk/akash -$ cd $GOPATH/src/github.com/ovrclk/akash -$ git checkout "v$AKASH_VERSION" -$ make deps-install -$ make install -``` - -Akash is developed and tested with [golang 1.16+](https://golang.org/). Building requires a working [golang](https://golang.org/) installation, a properly set `GOPATH`, and `$GOPATH/bin` present in `$PATH`. - -Once you have the dependencies properly setup, download and build `akash` using `make install` -{% endtab %} -{% endtabs %} diff --git a/other-resources/archived-resources/mainnet3-legacy-docs/shell-variables.md b/other-resources/archived-resources/mainnet3-legacy-docs/shell-variables.md deleted file mode 100644 index 97783d2e..00000000 --- a/other-resources/archived-resources/mainnet3-legacy-docs/shell-variables.md +++ /dev/null @@ -1,117 +0,0 @@ -# Setup your Environment - -Shell variables will be used throughout these guides to make the instructions so that the CLI commands in the documentation can be copied and pasted easily without editing at all. Below is a list of variables used and how to populate them. - -Note it is important to type the commands into a terminal where the variables have been defined. Closing or changing terminals will mean that you have to re-define your shell variables. - -### Environment Variables - -| Name | Description | -| ----------------------- | ----------------------------------------------------------------------------- | -| `AKASH_NET` | Akash network configuration base URL. | -| `AKASH_VERSION` | Akash version to install for your network. | -| `AKASH_CHAIN_ID` | Chain ID of the Akash network for [IBC](../../../cli/broken-reference/). | -| `AKASH_NODE` | Akash RPC endpoint URL and port number. | -| `AKASH_KEY_NAME` | Key name of your choosing. This documentation uses a value of "alice". | -| `AKASH_KEYRING_BACKEND` | Keyring backend to use for local keys. One of `os` (default), `file`, `test`. | - -### Environment Variables and flags - -Generally, every parameter set by CLI flag used by akash can be also set via environment variable. Use following rule of binding flag to the corresponding environment variable - -1. every dash `-` must be replaced with underscore `_`. `--` prefix must not be accounted! -2. make all characters capital case -3. add prefix `AKASH_` to the result - -for example flag `--keyring-backend` binds to `AKASH_KEYRING_BACKEND` environment variable - -The precedence is defined in the table below. 0 means highest priority - -| Priority | Type | -| -------- | -------------------- | -| 0 | Environment variable | -| 1 | Flag | -| 2 | Config file | -| 3 | Default value | - -Example below shows value precedence for `--keyring-backend` parameter. - -* use default value set to `os` - -``` -akash tx deployment create ... -#keyring-backend=os is used -``` - -* use value set by flag `--keyring-backend=file` - -``` -akash tx deployment create --keyring-backend=file ... -#keyring-backend=file is used -``` - -* use value set by environment variable `AKASH_KEYRING_BACKEND=test` - -``` -AKASH_KEYRING_BACKEND=test -akash tx deployment create --keyring-backend=file ... -#keyring-backend=test is used -``` - -## Key Name - -First, configure the name of your key. The command below will set the name of your key to `alice`, run the below command and replace `alice` with a name of your choice: - -```bash -AKASH_KEY_NAME=alice -``` - -**Key Ring Backend** - -Set the Key Ring Backend that you will use to store your key locally. The default is `os` and will store the key in your operating system, protected by your login password. You can change this to `file` or `test`. - -```bash -AKASH_KEYRING_BACKEND=os -``` - -## Network - -First, configure the base URL (`$AKASH_NET`) for the Akash Network; copy and paste the command below: - -```bash -AKASH_NET="https://raw.githubusercontent.com/ovrclk/net/master/mainnet" -``` - -## Version - -Next, configure the version of the Akash Network `AKASH_VERSION`; copy and paste the command below: - -```bash -AKASH_VERSION="$(curl -s "$AKASH_NET/version.txt")" -``` - -## Chain ID - -The akash CLI will recognize `AKASH_CHAIN_ID` environment variable when exported to the shell. - -```bash -export AKASH_CHAIN_ID="$(curl -s "$AKASH_NET/chain-id.txt")" -``` - -## RPC Endpoint - -Print a random RPC endpoint. The akash CLI will recognize `AKASH_NODE` environment variable when exported to the shell. - -```bash -export AKASH_NODE="$(curl -s "$AKASH_NET/rpc-nodes.txt" | shuf -n 1)" - -echo $AKASH_NODE -``` - -## API Endpoint - -Print a random API endpoint. - -```bash -curl -s "$AKASH_NET/api-nodes.txt" | shuf -n 1 -``` diff --git a/other-resources/archived-resources/mainnet3-legacy-docs/wallet.md b/other-resources/archived-resources/mainnet3-legacy-docs/wallet.md deleted file mode 100644 index 5fd8b448..00000000 --- a/other-resources/archived-resources/mainnet3-legacy-docs/wallet.md +++ /dev/null @@ -1,154 +0,0 @@ -# Create Your Account - -### Before We Begin - -In this guide, we'll generate a wallet address on your workstation. Make sure to have Akash client installed on your workstation. - -### What are Shell Variables? - -Shell variables will be used throughout these guides to make the instructions so that the commands can be used verbatim. The beginning of each guide will give a list of variables used and how to populate them. - -Closing or changing terminals will mean that you have to re-define the variable. Because of this, it is important to type the commands into a terminal where the variables have been defined. - -| Name | Description | -| ----------------------- | ----------------------------------------------------------------------------- | -| `AKASH_KEY_NAME` | Key name of your choosing. This documentation uses a value of "alice". | -| `AKASH_KEYRING_BACKEND` | Keyring backend to use for local keys. One of `os` (default), `file`, `test`. | - -### 1. Define your Shell Variables - -First configure the name of your key. The command below will set thee name of your key to `alice`, run the below command and replace `alice` with a name of your choice: - -```bash -AKASH_KEY_NAME=alice -``` - -Next, set the Key Ring Backend that you will use to store your key locally. The default is `os` and will store the key in your operating system, protected by your login password. You can change this to `file` or `test`. - -```bash -AKASH_KEYRING_BACKEND=os -``` - -### 2. Derive a New Key Locally - -Derive a new private key and encrypt to disk using the command `keys add` - -```bash -akash \ - --keyring-backend "$AKASH_KEYRING_BACKEND" \ - keys add "$AKASH_KEY_NAME" -``` - -You'll see a response similar to below: - -``` -- name: alice - type: local - address: akash1cz87pqkad72gggrv3t7y2x9z56h9gqghlnx3j3 - pubkey: akashpub1addwnpepqtnydvj056gy64uuquldq5yx7mr8ncmn3ut59wwl9p83d8h2v4rtg5xa3vn - mnemonic: "" - threshold: 0 - pubkeys: [] - - -**Important** write this mnemonic phrase in a safe place. It is the only way to recover your account if you ever forget your password. - -town wolf margin parrot strong disease dance eyebrow inflict meadow crunch version tube elite interest movie uphold column shift fox excuse humble nest call -``` - -In the above example, your new Akash address is `akash1cz87pqkad72gggrv3t7y2x9z56h9gqghlnx3j3` and generated mnemonic phrase is `town wolf margin .... humble nest call` - -**IMPORTANT:** It's imperative you keep the mnemonic phrase in a safe place. It is the ONLY way to recover your private key incase you change or lose your device. - -### 3. Derive a New Key using Ledger - -To derive a key and store it on the ledger, add the `--ledger` flag `keys add` command. For example: - -```bash -akash \ - --keyring-backend "$AKASH_KEYRING_BACKEND" \ - keys add "$AKASH_KEY_NAME" \ - --ledger -``` - -Will produce a similar output to: - -```yaml -- name: alice - type: ledger - address: akash1dt6wukc53dangle8qz7xjc792u0yrdc3esjlsp - pubkey: akashpub1addwnpepqvcsl4dxvsrdjyvd839uth7g96qhjq7jcxrnlf5qt0rgchutwcp8wgp4yk9 - mnemonic: "" - threshold: 0 - pubkeys: [] -``` - -### 4. Recovering Your Keys Using Pass Phrase - -The command to recover your key is: - -```bash -akash \ - --keyring-backend "$AKASH_KEYRING_BACKEND" \ - keys add "$AKASH_KEY_NAME" \ - --recover -``` - -This will prompt the user to input a bip39 mnemonic and looks similar to: - -``` -> Enter your bip39 mnemonic -diagram pony police cigar curious miracle multiply tiger salmon trade like month oven custom seven assume rail valid abuse forest mountain submit text print - -- name: alice - type: local - address: akash1skzh3hywj8x5ws7ed30qnz8zf2fq2va6nwdw6t - pubkey: akashpub1addwnpepqwyfrxddp5zs72qcyujlhky3rxlp80m7z7klyklpdq84mgw04aghvnr5rtz - mnemonic: "" - threshold: 0 - pubkeys: [] -``` - -### 5. Exporting Your Private Keys - -The command to export your private key is `keys export`. For example: - -```bash -akash \ - --keyring-backend "$AKASH_KEYRING_BACKEND" \ - keys export "$AKASH_KEY_NAME" -``` - -will output a response similar to: - -``` -Enter passphrase to decrypt your key: -Enter passphrase to encrypt the exported key: ------BEGIN TENDERMINT PRIVATE KEY----- -kdf: bcrypt -salt: DC5BA634306180096D7F9D19E94A7A9D -type: secp256k1 - -Hdv20eQY/mXdYD4a/zd6QPdBDkMHyyl2qY6Tun/UgQviUUyyTvzuVQgrrZ6tilRI -1FXXkwmeRPCOJ4v6oA2q536aM4Jmc5zYekgZ8OI= -=IGRD ------END TENDERMINT PRIVATE KEY----- -``` - -## 6. Get your Account Address - -You can now find your account address with this command: - -```bash -akash \ - --keyring-backend "$AKASH_KEYRING_BACKEND" \ - keys show "$AKASH_KEY_NAME" -a -``` - -You can now set the Shell Variable `AKASH_ACCOUNT_ADDRESS` for your account address: - -```bash -export AKASH_ACCOUNT_ADDRESS="$(akash keys show $AKASH_KEY_NAME -a)" - -echo $AKASH_ACCOUNT_ADDRESS -``` diff --git a/other-resources/experimental/ip-leases/ip-leases-verification.md b/other-resources/experimental/ip-leases/ip-leases-verification.md index 39474f1b..f5b9c0f0 100644 --- a/other-resources/experimental/ip-leases/ip-leases-verification.md +++ b/other-resources/experimental/ip-leases/ip-leases-verification.md @@ -2,7 +2,7 @@ Assigned IP Leases info can be displayed from the Akash CLI via the `lease-status` command. -_**NOTE**_** **_**-**_ ensure the `AKASH_DSEQ` and `AKASH_PROVIDER` environment variables are defined prior to issuing this command. Additional info on environment variables set up for the Akash CLI is available [here](../../archived-resources/mainnet3-legacy-docs/detailed-steps/part-4.-configure-your-network.md). +_**NOTE**_** **_**-**_ ensure the `AKASH_DSEQ` and `AKASH_PROVIDER` environment variables are defined prior to issuing this command. Additional info on environment variables set up for the Akash CLI is available [here](broken-reference). ``` provider-services lease-status --from $AKASH_ACCOUNT_ADDRESS diff --git a/other-resources/experimental/streamlined-steps/README.md b/other-resources/experimental/streamlined-steps/README.md index 68ee49df..454ecf5c 100644 --- a/other-resources/experimental/streamlined-steps/README.md +++ b/other-resources/experimental/streamlined-steps/README.md @@ -2,7 +2,7 @@ Akash CLI use has been streamlined in this guide. With the use of pre-defined environment variables, CLI commands are very concise. -For a more through review of the Akash CLI, including direct use of variables, visit the [Verbose Steps](../../archived-resources/mainnet3-legacy-docs/detailed-steps/) guide. +For a more through review of the Akash CLI, including direct use of variables, visit the [Verbose Steps](broken-reference) guide. ### Akash Wants to Spotlight Your Work diff --git a/other-resources/experimental/streamlined-steps/install-the-akash-client.md b/other-resources/experimental/streamlined-steps/install-the-akash-client.md index d50bf94e..245e4440 100644 --- a/other-resources/experimental/streamlined-steps/install-the-akash-client.md +++ b/other-resources/experimental/streamlined-steps/install-the-akash-client.md @@ -2,7 +2,7 @@ -The below set of steps downloads the environment for easier setup. For advanced usage, check [Install Akash CLI client](../../archived-resources/mainnet3-legacy-docs/detailed-steps/part-1.-install-akash.md). +The below set of steps downloads the environment for easier setup. For advanced usage, check [Install Akash CLI client](broken-reference). ## Download Source Code diff --git a/providers/build-a-cloud-provider/akash-cloud-provider-build-with-helm-charts/step-1-prerequisites-of-an-akash-provider.md b/providers/build-a-cloud-provider/akash-cloud-provider-build-with-helm-charts/step-1-prerequisites-of-an-akash-provider.md index 10f2e292..bcf17bcf 100644 --- a/providers/build-a-cloud-provider/akash-cloud-provider-build-with-helm-charts/step-1-prerequisites-of-an-akash-provider.md +++ b/providers/build-a-cloud-provider/akash-cloud-provider-build-with-helm-charts/step-1-prerequisites-of-an-akash-provider.md @@ -6,7 +6,7 @@ Placing a bid on an order requires a 5 AKT deposit placed into collateral per bi As every deployment request bid requires 5 AKT to be deposited in the escrow account, it's always good to have more so your provider can keep bidding. If your provider is ready to offer 10 deployments, then it's best to have 5 x 10 = 50 AKT and a little more to make sure provider can pay the fees for broadcasting the transactions on Akash Network. -The steps to create an Akash wallet are covered in the Provider setup section of this [document](../../../other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/part-1.-install-akash.md) (_**Parts 1-3 )**_. +The steps to create an Akash wallet are covered in the Provider setup section of this [document](broken-reference) (_**Parts 1-3 )**_. ## **Kubernetes Cluster** diff --git a/providers/build-a-cloud-provider/akash-provider-troubleshooting/provider-earnings.md b/providers/build-a-cloud-provider/akash-provider-troubleshooting/provider-earnings.md index 810c8ff1..894057a3 100644 --- a/providers/build-a-cloud-provider/akash-provider-troubleshooting/provider-earnings.md +++ b/providers/build-a-cloud-provider/akash-provider-troubleshooting/provider-earnings.md @@ -97,7 +97,7 @@ For accurate earning potential based on today's actual financial/other realities ### Command Syntax -Issue the commands in this section from any machine that has the [Akash CLI](../../../other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/) installed. +Issue the commands in this section from any machine that has the [Akash CLI](broken-reference) installed. **Note** - ensure queries are not limited only to leases created by your account by issuing `unset AKASH_FROM` prior to the `akash query market` command execution diff --git a/providers/build-a-cloud-provider/akash-provider-troubleshooting/provider-status-and-general-info.md b/providers/build-a-cloud-provider/akash-provider-troubleshooting/provider-status-and-general-info.md index 4446da2a..cc06f130 100644 --- a/providers/build-a-cloud-provider/akash-provider-troubleshooting/provider-status-and-general-info.md +++ b/providers/build-a-cloud-provider/akash-provider-troubleshooting/provider-status-and-general-info.md @@ -95,7 +95,7 @@ Review the Provider’s attribute, and Host URI with the status command ### Command Template -Issue the commands in this section from any machine that has the [Akash CLI](../../../other-resources/archived-resources/mainnet3-legacy-docs/detailed-steps/) installed. +Issue the commands in this section from any machine that has the [Akash CLI](broken-reference) installed. ``` provider-services query provider get diff --git a/token/funding.md b/token/funding.md index 5c0e8c20..47d2bcb8 100644 --- a/token/funding.md +++ b/token/funding.md @@ -4,6 +4,6 @@ Developers can request funding by joining the Akash Community. If you need tokens to experiment with your first deployment, please make a request via our Discord server and in the `general-chat` channel. -* [ ] [Install Akash and create an account](../other-resources/archived-resources/mainnet3-legacy-docs/install.md) +* [ ] [Install Akash and create an account](broken-reference) * [ ] [Join our Discord server](https://discord.com/invite/DxftX67) * [ ] [Submit a Grant Application](https://forum.akash.network/t/2022-grant-applications-submit-here/3453)