From c54307a22e29a0a4bf481ae65b3e7d9cae11ab81 Mon Sep 17 00:00:00 2001 From: boneyard93501 <4523011+boneyard93501@users.noreply.github.com.> Date: Tue, 18 Feb 2025 12:00:10 -0600 Subject: [PATCH 1/7] edits --- docs/build/balance/balance.md | 36 ++++++------- docs/build/manage_vm/manage_vm.md | 19 +++---- docs/build/overview.md | 6 +-- docs/build/registration/registration.md | 12 ++--- docs/build/settings/settings.md | 20 +++---- docs/build/vm_rent/vm_rent.md | 72 +++++++++++-------------- 6 files changed, 70 insertions(+), 95 deletions(-) diff --git a/docs/build/balance/balance.md b/docs/build/balance/balance.md index b91baa6..cb7a915 100644 --- a/docs/build/balance/balance.md +++ b/docs/build/balance/balance.md @@ -4,39 +4,31 @@ After registering through Fluence Console, a new Self-Custodial Wallet is created for each user using Web3Auth. However, in this case, interacting with smart contracts in the Fluence network still requires signing blockchain transactions each time. -To simplify the process of interacting with the Blockchain network through Fluence Console, the Fluence uses [account abstraction](https://web3auth.io/docs/features/account-abstraction) to handle user balances. Hence, topping up your balance is reflected in the [Balance smart contract](https://blockscout.mainnet.fluence.dev/address/0xF0C308C622eeBA94aeEc2E3Fd67F34619f86761B). At the same time, the functionality of the Balance smart contract is extremely limited to ensure maximum security of user funds. - -Thus, when replenishing your Balance through Fluence Console, user funds are transferred to a special smart contract, not directly to the address created through Web3Auth. +Fluence Console simplifies interacting with the blockchain by using [account abstraction](https://web3auth.io/docs/features/account-abstraction) to manage user balances. Hence, topping up your balance is reflected as a transaction in the secure [Balance smart contract](https://blockscout.mainnet.fluence.dev/address/0xF0C308C622eeBA94aeEc2E3Fd67F34619f86761B) and not the Web3Auth wallet created during registration. :::danger -The balance top upped through Fluence Console can only be used to rent resources in the Fluence network. To interact with other protocol mechanics, such as Staking, you need to top up the address created through Web3Auth or any other EOA directly, for example, by using a Bridge from Ethereum to Fluence Mainnet network. +The balance top upped through Fluence Console can only be used to rent resources from the Fluence network. To interact with other protocols, such as Fluence Staking. ::: :::info -Fluence Console users cannot top up their Balance by themselves on the Fluence platform (stored in Balance smart contract) from addresses created through Web3Auth or through any other third-party EOA. This restriction is related to AML (Anti-Money Laundering) limitations. Also, Fluence Console users cannot independently withdraw funds from their balance on the Fluence platform. If a refund is needed, please contact the Fluence team. +Fluence Console users cannot top up their Balance from addresses created through Web3Auth or through any other EOA. This restriction is related to AML (Anti-Money Laundering) limitations. Also, Fluence Console users cannot directly withdraw funds from the Balance contract. If a refund is needed, please contact the Fluence team. ::: ## Steps to top up Balance on the Fluence Platform :::info -Participants in the Alpha VM testing program will receive 256 USDC in Free Credits on their balance after registering on the Fluence platform. +Participants in the Alpha VM testing program receive 256 USDC in their balance credits after the registration process is completed. ::: -Currently, replenishing the Balance through Fluence Console is done using the payment provider CopperX. - -:::info -Currently, payment is available in the Ethereum (USDC) and Polygon (USDC.e) networks. Please note that after successful payment through CopperX in one of the available networks, your Balance will be automatically top up in the Balance smart contract in the Fluence Mainnet network. -::: +Currently, you fund your Balance using the payment provider CopperX, which offers payment options for Ethereum (USDC) and Polygon (USDC.e). The Fluence Console integrates CopperX payment and event monitoring. Once your CopperX payment is successfully executed, the Balance smart contract reflects the transaction. -To top up your balance, follow these steps: +To top up your balance wih CopperX, follow these steps: ### 1. Click the Top Up button Go to the **Billing page** and click the **“Top Up”** button. :::info -Please note that at the moment, a user cannot have multiple pending Balance top-up operations. If a user, for any reason, cannot complete the payment, they must [cancel](#cancel-payment) the Balance top-up operation via CopperX. - You can check for pending payment sessions on the **Billing page**, in the **Payments History** section. Pending payment sessions have the status `Pending`. ::: ![top up button](./assets/top_up_button.webp) @@ -44,25 +36,25 @@ You can check for pending payment sessions on the **Billing page**, in the **Pay ### 2. Enter the amount you want to top up your Balance with :::info -Currently, the **minimum** top up amount is **10 USDC**. At the same time, your balance on the Fluence platform cannot exceed **5000 USDC**. +Currently, the minimum top up amount is **USDC 10.00** while your total balance cannot exceed **USDC 5000.00**. ::: ![enter amount](./assets/amount.webp) ### 3. Enter your details -You will then be redirected to the CopperX payment page, where you will need to enter your details. +You will be redirected to the CopperX payment page. ![copperx payment page](./assets/payment_page.webp) #### Cancel payment :::info -To cancel a payment, use the corresponding option in the CopperX interface. If the payment is not completed within 15 minutes, the payment session will automatically end. +To cancel a payment, use the corresponding option in the CopperX interface. If a payment is not completed within 15 minutes, the payment will be automatically cancelled. ::: ![cancel payment](./assets/cancel.webp) ![cancel result](./assets/cancel_res.webp) :::info -If you accidentally close the CopperX payment page, you can always return to the Fluence Console interface and go back to the payment page. +If you accidentally close the CopperX payment page, go back to the Fluence Console payment page. ::: ![return to payment page](./assets/return_to_payment.webp) @@ -75,8 +67,12 @@ If you encounter issues with the “Wallet” payment option, we recommend using ### 5. Back to Fluence Console -After a successful payment you will be redirected back to the **Fluence Console** page. The payment will be in the Pending status for some time, as the system will need time to top up your Balance in the Fluence Mainnet network. +After a successful payment, you will be redirected back to the **Fluence Console** page. The payment will be in the `Pending` status for a bit. + +:::info +At this time, you cannot have multiple pending Balance top-up operations. If you cannot complete a CopperX payment and don't want to wait 15 minutes, you need to [cancel to the payment](#cancel-payment). +::: ### 6. Wait for "Completed" payment status -Once the payment status changes to `Completed` your funds will be credited to your Fluence platform Balance. +Once the on-chain transactions are processed, the Balance smart contract will reflect your payment and the FLuence Console payment status updates to `Completed`. diff --git a/docs/build/manage_vm/manage_vm.md b/docs/build/manage_vm/manage_vm.md index 990b867..aaa8cfc 100644 --- a/docs/build/manage_vm/manage_vm.md +++ b/docs/build/manage_vm/manage_vm.md @@ -1,32 +1,25 @@ # CPU VM Info and Management -After renting a VM, the user can view all the relevant information about the rented resources on the Running Instances page, as well as manage the rented VM. +After renting a VM, all the relevant information is accessible on the **Running Instances** page. ## VM Information -After renting a VM, a corresponding card will appear on the **Running Instances** page, which can be expanded to view all the parameters of the rented VM. Please note that the user can now see **more detailed information** about the server hardware in the `Hardware Specs` section, as a specific server has already been allocated at this stage. - -:::info -The user will be able to see extended server parameters only if the specific infrastructure provider has provided the necessary information when registering in the Fluence protocol. Since Fluence currently whitelists providers, in most cases, providers provide all the necessary information. -::: +After renting a VM, a corresponding card will appear on the **Running Instances** page, which can be expanded to view all the parameters of the rented VM and detailed information can be found in the `Hardware Specs` section. Note that +the extended server parameters are only visible if the specific infrastructure provider has provided this necessary information. ![VM information](./assets/vm_info.webp) -The user can also see the maximum rental period for the VM (`Expires in`) and information about the next billing time (`Next billing time`), which occurs daily at **5:55 PM UTC**. +The user can also see the maximum rental period for the VM (`Expires in`) and information about the next billing time (`Next billing time`) set at **5:55 PM UTC**. ## VM Management -Currently, the only operation available for a running VM is `Delete`, which terminates the VM and the rental agreement. The ability to Reboot, Reset, and Rebuild will be added soon. +Currently, the only operation available for a running VM is `Delete`, which terminates the VM and the rental agreement. The ability to Reboot, Reset, and Rebuild from the Fluence Console will be added soon. ![VM management](./assets/vm_manage.webp) ## Billing History -After renting a VM, the user can view the history of charges on the **Billing page** in the **Billing History** section. - -:::info -Please note that if your Balance on the Fluence platform does not have enough funds to pay for the next day of VM rental, the funds reserved when creating the VM will be used for payment. After the reserved funds are exhausted, in the next Billing cycle (the next day), the user's rent will be terminated, and the VM will be automatically deleted. -::: +The history of your charges can be found on the **Billing page** in the **Billing History** section. ![Billing history](./assets/billing_history.webp) diff --git a/docs/build/overview.md b/docs/build/overview.md index aee1ea9..e9934d2 100644 --- a/docs/build/overview.md +++ b/docs/build/overview.md @@ -1,6 +1,6 @@ # Overview -**Fluence Console** is one of the main ways to rent resources from the decentralized Fluence compute marketplace. It is a web-based application that allows you control the complete lifecycle of your resources and services and mange your payments and billing in one central locations. +**Fluence Console** is one of the main ways to rent resources from the decentralized Fluence compute marketplace. It is a web-based application that allows you control the complete lifecycle of your resources and services and mange your payments and billing in one convenient location. ## Fluence Console Access @@ -8,6 +8,4 @@ Currently, Fluence Console is available only as part of the closed Alpha VM testing program. ::: -The Fluence Console web app is available via the following URL: - -[https://alpha.fluence.dev/](https://alpha.fluence.dev/) +Access the Fluence Console: [https://alpha.fluence.dev/](https://alpha.fluence.dev/) diff --git a/docs/build/registration/registration.md b/docs/build/registration/registration.md index c7a6dcb..f975a89 100644 --- a/docs/build/registration/registration.md +++ b/docs/build/registration/registration.md @@ -2,9 +2,9 @@ ## Self-Custodial Wallet -Since smart contracts are used to manage and rent resources from the Fluence network, any user interacting with the Fluence network needs to use a Web3 Blockchain wallet. However, managing a regular EOA (Externally Owned Account) address comes with certain risks and inconveniences. +Smart contracts are used to rent and manage resources from the Fluence network, requiring users to use an [EVM wallet](https://blog.thirdweb.com/what-are-evm-wallets/). However, managing externally owned account (EOA) wallets, aka "regular" wallets, comes with certain limitations and pitfalls. -To address this, our system uses a unique Self-Custodial Wallet based on a [solution from Web3Auth](https://web3auth.io/docs/how-web3auth-works), which operates on the [MPC](https://web3auth.io/docs/features/mpc) (Multi-Party Computation) protocol, instead of a standard EOA address. Thus, after a user registers through **Fluence Console**, a unique address is generated for them, and only the user has access to the private key. The private key is securely stored in parts within the distributed Web3Auth network and is protected by the MPC protocol. In turn, the Fluence protocol only has access to the user’s public address. +To address these concerns, our system uses a unique Self-Custodial Wallet based on a [solution from Web3Auth](https://web3auth.io/docs/how-web3auth-works), which operates on the [MPC](https://web3auth.io/docs/features/mpc) (Multi-Party Computation) protocol, instead of a standard EOA address. Thus, after a user registers through **Fluence Console**, a unique address is generated for them, and only the user has access to the private key. The private key is securely stored in parts within the distributed Web3Auth network and is protected by the MPC protocol. In turn, the Fluence protocol only has access to the user’s public address. ## Registration Process @@ -13,9 +13,9 @@ Please note that during registration, you must use the email address you provide ::: If you are using the Fluence Console for the first time, you need to register using one of the following methods: -1. Email Passwordless -1. via Google account -1. via GitHub account +1. [Email Passwordless Login](https://web3auth.io/docs/auth-provider-setup/social-providers/email-passwordless#helper-sdks-menu) +2. Google account +3. GitHub account :::warning If you register with the same email through Google and Email Passwordless, two different accounts will be created for you. @@ -23,4 +23,4 @@ If you register with the same email through Google and Email Passwordless, two d ![registration page](./assets/registration.webp) -After successful registration, participants in the Alpha VM testing program will gain access to the full functionality of Fluence Console. +After successful registration, you have access to the Fluence Console. diff --git a/docs/build/settings/settings.md b/docs/build/settings/settings.md index 722acac..ac5906f 100644 --- a/docs/build/settings/settings.md +++ b/docs/build/settings/settings.md @@ -1,33 +1,33 @@ # Fluence Console Settings -On the **Settings** page, users can manage additional features of the Fluence platform. +Use the **Settings** page to manage your SSH and API keys and more. ## SSH Keys -On **SSH keys** page, users have access to the following functionality: -1. Creating a new SSH key. Currently, the following SSH key formats are supported: RSA, ECDSA, and ED25519. -1. Deleting SSH keys. +On **SSH keys** page, you can: +1. Creating a new key. Currently, the following SSH key formats are supported: RSA, ECDSA, and ED25519. +2. Deleting existing keys. ![SSH keys page](./assets/ssh_keys.webp) ## API Keys -Users of the Fluence platform have the ability to manage their infrastructure without using **Fluence Console** through the **Public API**. +Instead of using the **Fluence Console**, yo cna manage your resources also through the **Public API**. :::info -In the first stage of the **Alpha VM testing**, users will not have access to the **Public API** functionality. The Fluence team will separately notify and provide the relevant documentation when this functionality becomes available. +In the first stage of the **Alpha VM testing**, you will not have access to the **Public API**. The Fluence team will notify you when this functionality becomes available. ::: On the API Keys page, users can: 1. Create a new API key. Currently, it is possible to specify `Permissions` and `Expiration time` separately. -1. Delete an API key. +2. Delete an API key. ![API keys page](./assets/api_keys.webp) ## Advanced Settings -For each user, a separate **self-custodial wallet** is created through Web3Auth when registering through Fluence Console. However, the user’s Balances on the Fluence platform are not stored on the created addresses but in a separate **Balance smart contract** in Fluence mainnet network. On the **Advanced Settings** page, users can get information about: -1. The **public address** of the wallet created through Web3Auth. -1. The **address of the Balance smart contract** in the Fluence Mainnet network. +On the **Advanced Settings** page, users can get information about: +1. The **public address** of the wallet created through Web3Auth at the time of registration +2. The **address of the Balance smart contract** needed to track your Balance transactions ![Advanced settings page](./assets/advanced_settings.webp) diff --git a/docs/build/vm_rent/vm_rent.md b/docs/build/vm_rent/vm_rent.md index 2e957d8..d46832f 100644 --- a/docs/build/vm_rent/vm_rent.md +++ b/docs/build/vm_rent/vm_rent.md @@ -1,108 +1,96 @@ -# CPU VM Renting +# Renting a VM -Currently, on the Fluence platform, it is possible to rent resources in the form of CPU VMs with various configurations. It is important to note that the rental process involves smart contracts in the Fluence network, which regulate the relationship between the user and the compute resource provider for launching and properly functioning the VM. +The Fluence marketplace is a decentralized broker of compute supply and demand governed by a set of smart contracts. To this end, the Fluence marketplace not only facilitates the renting process of a VM between you and one of the participating compute providers but also the configuration and management of your VM. -Currently, due to the specifics of the Fluence protocol, there are several important limitation for rented VMs: +Currently, there are several limitation concerning VM rental: -1. **VMs can only be rented for a limited period**. Since the Fluence protocol uses the **Capacity Commitment (CC)** and **Staking** mechanics to verify the provider’s infrastructure, the rental period for a specific server is limited by the duration of the Capacity Commitment created for it. After the Capacity Commitment ends, the Fluence protocol stops verifying the provider’s infrastructure, meaning there is no guarantee of the server’s availability. - :::info - When renting a server through Fluence Console, users can explicitly see the maximum rental duration for a CPU VM. - ::: +1. A VM can only be rented for a limited period of time. This current limitation is due implementation specifics of the verification, i.e., capacity commitment, and security, i.e., staking, protocols. The exact maximum rental period for a VM can be seen in the Fluence Console. -1. When renting a VM, an additional amount equal to one day’s rent is deducted from the user’s balance. This amount is held as a 'prepayment' for the next day’s rental. It is refunded to your Fluence Balance once the rental period ends — unless your balance runs out and the prepaid amount is used to cover the VM costs. - :::info - Users can always check the amount of Balance reserved as a “prepayment” on the Billing page. - ::: +2. When renting a VM, a prepayment amount equivalent to one day’s rent is deducted from your Balance to cover the next day’s rent. This amount is refunded to your Balance when the rental period ends, unless your balance runs out and the prepaid amount is used to cover that day's VM cost. You can check the amount of your Balance reserved as a “prepayment” on the Billing page in the Fluence Console. -## Steps to Configure a Rented VM +:::warning +If your Balance does not have enough funds to pay for the next day's rent, the previously deducted prepayment will be used to cover the rent. After the reserved funds are exhausted and you fail to top up o Balance in time, the VM's rental agreement will be terminated and the VM will be automatically deleted. +::: + +## Steps to Configure a VM -The Fluence protocol provides users of the Fluence platform with access to a variety of commercial-grade server hardware from reliable Tier-1 to Tier-4 data centers around the world. To rent a VM, follow these steps: +The Fluence marketplace aggregates enterprise-grade compute resources from predominantly Tier-3 and Tier-4 data centers around the world. To rent a VM: ### 1. Choose location -Choose one of the available Locations for renting a VM. +Choose one of the available data center locations. ![choose location](./assets/location.webp) ### 2. Choose configuration -Choose a Basic configuration. Currently, Fluence provides a fixed set of CPU and RAM configurations for VMs that users can rent. +Choose your VM's configuration from the available options. Currently, compute resources can only be rented in multiples of a compute unit, which is 2 vCPUs and 4 GB of RAM. In the future, this limitation will be removed and compute resources can be added in a fine-grained manner for both vCPUs and RAM. -:::info -Currently, compute resources can only be rented in multiples of a compute unit, which is 2 vCPUs and 4 GB. In the future, this limitation will be removed and compute resources can be added in a fine-grained manner for both vCPUs and RAM. -::: ![choose configuration](./assets/configuration.webp) ### 3. Choose storage -Choose the type of Storage and its amount. Currently, the minimum Storage size for a VM is 25 GB. When renting a VM, DAS Storage is allocated, physically located on the same server as the CPU and RAM resources. This ensures higher Storage performance compared to NAS but limits the ability to expand it. +Choose the type and amount of storage desired. Currently, the minimum storage size for a VM is 25 GB. At this point, only DAS storage is available, which ensures better performance than shared network solutions, like NAS, but does not allow for dynamic resizing. ![choose storage](./assets/storage.webp) -### 4. Choose server type +### 4. Choose the server type -Specify the Server type for the VM. Since the hardware in the Fluence protocol can vary , the user needs to pay attention to the provided information as the price of resources may vary depending on the quality of the hardware. Users also need to utilized the Data Center information provided. In Fluence Console, users are provided with a Data Center's geo info at the city level, available certifications and more. +Specify the Server type for the VM. Since hardware within and across data centers may vary, pay close attention to the available hardware specifications and price. Moreover, Fluence Console allows you to view a data center's geo location at the city level and other important details such as available certifications. ![choose server type](./assets/server_type.webp) :::info -The choice of **Server type** also affects the rental duration of the VM. Pay attention to the `Expires in` parameter in the **Review** block. If the user is not satisfied with the rental period, they can try selecting a different Server type. Currently, the maximum available rental period is set by default for each Server type. +The choice of **Server type** also affects the rental duration of the VM. Pay attention to the `Expires in` parameter in the **Review** block. If you are not satisfied with the length of the rental period, you can try selecting a different Server type. ::: -### 5. Rent Public IPv4 address +### 5. Rent a Public IPv4 address -Currently, users can only access their VMs via SSH over the public IPv4 allocated to the VM. In the future, the requirement for a Public IPv4 to access a VM will be removed. +Currently, you can only access yor VM via SSH over the public IPv4 allocated to the VM. In the future, the requirement for a Public IPv4 to access a VM will be removed. ![rent public IPv4 address](./assets/public_ip.webp) -After selecting all the resource parameters for the VM, the user can proceed to the settings related to the workload that will be launched inside the VM. +Yu are now ready to configure your VM. ### 6. Specify VM name -Specify a **name for the VM**. Currently, the VM name must be unique within a specific user account. +Specify a **name for the VM**. Currently, the VM name must be unique within a your (user) account. ![specify VM name](./assets/vm_name.webp) ### 7. Specify the ports -Specify the **ports that need to be opened** for the VM. By default, all ports except **port 22** are closed. Therefore, before renting a VM, the user needs to select which ports need to be opened. Currently, all open ports support **TCP** and **UDP** protocols. The user can open **up to 50 ports**. +Specify the ports you want opened at startup. By default, all ports except **port 22** are closed. Note that all open ports support **TCP** and **UDP** and you can open up to 50 ports. -:::danger -Currently, it is not possible to change the set of open ports through **Fluence Console** after renting a VM. After renting a VM, users will be able to configure their own Firewall and **close** the necessary ports. However, users will not be able to **open** ports that were closed during the VM renting process. +:::info +Currently, it is not possible to change the set of open ports through **Fluence Console** after the VM is initiated. While you are able to configure your own Firewall and **close** ports originally asked to be opened, you will not be able to **open** ports not specified to be open at VM creation. ::: ![specify ports](./assets/ports.webp) ### 8. Choose the OS image -Choose the **OS image** for launching the VM. Users can either choose a pre-defined OS image or provide a link to their **custom OS image**. It is important to note the following limitations on custom OS images: - -- The Custom OS image must be available for download via a publicly accessible link. -- The Custom OS image must be intended for running on the remote instance(s). The Fluence team recommends choosing images with the `Generic Cloud` or `Cloud` tags. +Choose the **OS image** for your VM. You can either choose a pre-defined OS image or provide a link to a **custom OS image**. Note that a custom OS image must be available for download from publicly accessible link and must be configured for running on remote instances. The Fluence team recommends choosing images with the `Generic Cloud` or `Cloud` tags. ![choose OS image](./assets/os_image.webp) ### 9. Provide the public SSH key -Provide the public SSH key for connecting to the VM, which is currently only possible via SSH using the public IPv4 address allocated to your VM. Thus, you need to specify at least one SSH key in one of the following formats: RSA, ECDSA, or ED25519. +Provide the public SSH key for connecting to the VM. You need to specify at least one SSH key in either RSA, ECDSA or ED25519 format. ![provide SSH key](./assets/ssh.webp) ### 10. Review the summary -After selecting all the VM parameters, the user can see a quick summary in the Review section, including the final rental price of the VM. +After selecting all the VM parameters, you can see the instance summary and price in the Review section. ![review summary](./assets/summary.webp) -### 11. Click the Launch button - -Click the “Launch” button to rent the VM. After that, you will be redirected to the Running Instances page to manage the launched VM. +### 11. Launch the VM -:::info -Currently an additional amount equal to the cost of one day’s rent is deducted from the user’s Balance, which is reserved as a “prepayment” until the rental is canceled. Immediately after canceling the VM rental, this amount will be returned to the user’s Balance provided that the "prepayment" amount was not used to pay for the VM after the entire Balance on the Fluence platform was exhausted. The reserved amount is displayed on the **Billing page** under the name `Reserved for running workload`. -::: +Click the “Launch” button to rent the VM and you will be redirected to the Running Instances page. :::warning -Please note **payment for rented VMs occurs at the same time every day at** `5:55 PM UTC`. Also, payment is currently only possible for full days, regardless of the rental start time. Thus, if a user rents a VM at `5:45 PM UTC`, they will pay for a **FULL** day of rent and 10 minutes later, at `5:55 PM UTC`, they will pay for another **FULL** day. This limitation is also expected to be remedied in the near future. +Please note payment for VMs occurs every day at **`5:55 PM UTC`** and currently only possible for full days regardless of the rental start time. Thus, if you rent a VM at `5:45 PM UTC`, you will pay for a **FULL** day for ten minutes of use. At `5:55 PM UTC`, the next full payment is due. This limitation is also expected to be remedied in the near future. ::: From 41c8354a341b29d5fa3d54cb97c050e8cecdff2d Mon Sep 17 00:00:00 2001 From: boneyard93501 <4523011+boneyard93501@users.noreply.github.com.> Date: Tue, 18 Feb 2025 13:39:24 -0600 Subject: [PATCH 2/7] edits --- docs/build/overview.md | 6 +++--- docs/build/registration/registration.md | 6 ++++-- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/build/overview.md b/docs/build/overview.md index e9934d2..70d771c 100644 --- a/docs/build/overview.md +++ b/docs/build/overview.md @@ -1,11 +1,11 @@ # Overview -**Fluence Console** is one of the main ways to rent resources from the decentralized Fluence compute marketplace. It is a web-based application that allows you control the complete lifecycle of your resources and services and mange your payments and billing in one convenient location. +**Fluence Console** is the convenient way to renting and managing resources from the decentralized Fluence compute marketplace. It is a web-based application that allows you to control the complete lifecycle of your resources and services including your payments and billing. ## Fluence Console Access -:::warning -Currently, Fluence Console is available only as part of the closed Alpha VM testing program. +:::info +Access to Fluence Console is currently only available to participants of the Alpha VM testing program. ::: Access the Fluence Console: [https://alpha.fluence.dev/](https://alpha.fluence.dev/) diff --git a/docs/build/registration/registration.md b/docs/build/registration/registration.md index f975a89..7581947 100644 --- a/docs/build/registration/registration.md +++ b/docs/build/registration/registration.md @@ -2,9 +2,11 @@ ## Self-Custodial Wallet -Smart contracts are used to rent and manage resources from the Fluence network, requiring users to use an [EVM wallet](https://blog.thirdweb.com/what-are-evm-wallets/). However, managing externally owned account (EOA) wallets, aka "regular" wallets, comes with certain limitations and pitfalls. +As a decentralized project, self-custody over your wallet is a critical requirement for you stay in control over your data and resources. Yet, managing crypto wallets not only comes with certain limitations and pitfalls but also decouple users from well-known processes when it comes to account registration and log-ins. -To address these concerns, our system uses a unique Self-Custodial Wallet based on a [solution from Web3Auth](https://web3auth.io/docs/how-web3auth-works), which operates on the [MPC](https://web3auth.io/docs/features/mpc) (Multi-Party Computation) protocol, instead of a standard EOA address. Thus, after a user registers through **Fluence Console**, a unique address is generated for them, and only the user has access to the private key. The private key is securely stored in parts within the distributed Web3Auth network and is protected by the MPC protocol. In turn, the Fluence protocol only has access to the user’s public address. +To address these concerns while still providing you with the self-custodial powers, our registration and login system uses the [Web3Auth](https://web3auth.io/docs/how-web3auth-works) solution, which works as follows: after you register through **Fluence Console**, a unique (wallet) address is generated and only you have access to the private key. However, the private key is securely stored in parts on Web3Auth's [MPC](https://web3auth.io/docs/features/mpc) (Multi-Party Computation) network. As a result, you have a self-custodial wallet that eliminates catastrophic (loss) failures commonly encountered with traditional, self-managed and seed-based wallets. + +Of course, Fluence Console only has access to your wallets public key. ## Registration Process From 9327393f4d832310ee9844dd93cd72a350b3af7e Mon Sep 17 00:00:00 2001 From: boneyard93501 <4523011+boneyard93501@users.noreply.github.com.> Date: Tue, 18 Feb 2025 13:40:32 -0600 Subject: [PATCH 3/7] fix sp --- docs/build/registration/registration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build/registration/registration.md b/docs/build/registration/registration.md index 7581947..ce6ac6d 100644 --- a/docs/build/registration/registration.md +++ b/docs/build/registration/registration.md @@ -6,7 +6,7 @@ As a decentralized project, self-custody over your wallet is a critical requirem To address these concerns while still providing you with the self-custodial powers, our registration and login system uses the [Web3Auth](https://web3auth.io/docs/how-web3auth-works) solution, which works as follows: after you register through **Fluence Console**, a unique (wallet) address is generated and only you have access to the private key. However, the private key is securely stored in parts on Web3Auth's [MPC](https://web3auth.io/docs/features/mpc) (Multi-Party Computation) network. As a result, you have a self-custodial wallet that eliminates catastrophic (loss) failures commonly encountered with traditional, self-managed and seed-based wallets. -Of course, Fluence Console only has access to your wallets public key. +Of course, Fluence Console only has access to your wallet's public key. ## Registration Process From 59ead7da3918710a54b1daa08343ba622594fa7d Mon Sep 17 00:00:00 2001 From: boneyard93501 <4523011+boneyard93501@users.noreply.github.com.> Date: Tue, 18 Feb 2025 14:04:20 -0600 Subject: [PATCH 4/7] edits --- docs/build/balance/balance.md | 29 ++++++++++++----------------- 1 file changed, 12 insertions(+), 17 deletions(-) diff --git a/docs/build/balance/balance.md b/docs/build/balance/balance.md index cb7a915..acd3de0 100644 --- a/docs/build/balance/balance.md +++ b/docs/build/balance/balance.md @@ -1,28 +1,23 @@ -# Balance top up +# Payment And Balance Management -## Features of Balance Management on the Fluence Platform +In order to rent a VM from the Fluence marketplace, you need to provide funds to the marketplace which are used to pay for your rented resources. It is important to note that allocated funds are managed by smart contracts and based on your VM configuration and price, the smart contracts periodically charge the rent due to the compute provider. Throughout this document, we refer to the funds escrowed to these smart contracts as the Balance. -After registering through Fluence Console, a new Self-Custodial Wallet is created for each user using Web3Auth. However, in this case, interacting with smart contracts in the Fluence network still requires signing blockchain transactions each time. -Fluence Console simplifies interacting with the blockchain by using [account abstraction](https://web3auth.io/docs/features/account-abstraction) to manage user balances. Hence, topping up your balance is reflected as a transaction in the secure [Balance smart contract](https://blockscout.mainnet.fluence.dev/address/0xF0C308C622eeBA94aeEc2E3Fd67F34619f86761B) and not the Web3Auth wallet created during registration. - -:::danger -The balance top upped through Fluence Console can only be used to rent resources from the Fluence network. To interact with other protocols, such as Fluence Staking. -::: +The Fluence Console simplifies interacting with the blockchain by using [account abstraction](https://web3auth.io/docs/features/account-abstraction) to manage balances. As a result, topping up your balance is reflected as a transaction in the secure [Balance smart contract](https://blockscout.mainnet.fluence.dev/address/0xF0C308C622eeBA94aeEc2E3Fd67F34619f86761B) and not the Web3Auth wallet created during registration. Note that the Balance can only be used to rent resources from the Fluence network and that you cannot directly withdraw funds from the Balance contract. If a refund is required, please contact the Fluence team. :::info -Fluence Console users cannot top up their Balance from addresses created through Web3Auth or through any other EOA. This restriction is related to AML (Anti-Money Laundering) limitations. Also, Fluence Console users cannot directly withdraw funds from the Balance contract. If a refund is needed, please contact the Fluence team. +Fluence Console users **cannot** top up their Balance from the newly created Web3Auth or any other wallet you may own. This restriction is related to AML (Anti-Money Laundering) limitations. Instead, Fluence Console users need to go through whitelisted payment portals such as CopperX. ::: -## Steps to top up Balance on the Fluence Platform +## Topping up the Balance :::info -Participants in the Alpha VM testing program receive 256 USDC in their balance credits after the registration process is completed. +Participants in the Alpha VM testing program receive 256 USDC in balance credits. This amount should easily get you through the testing period and it is doubtful that you will need to top up the Balance during the testing phase. ::: -Currently, you fund your Balance using the payment provider CopperX, which offers payment options for Ethereum (USDC) and Polygon (USDC.e). The Fluence Console integrates CopperX payment and event monitoring. Once your CopperX payment is successfully executed, the Balance smart contract reflects the transaction. +Currently, you fund your Balance using [CopperX](https://copperx.io/), which offers payment options for Ethereum (USDC) and Polygon (USDC.e). The Fluence Console integrates CopperX payment and event monitoring providing a seamless experience to establish payments to the Balance smark contracts. Once your CopperX payment is successfully executed, the Balance smart contract will reflect the transaction. -To top up your balance wih CopperX, follow these steps: +To initiate a payment with CopperX, follow these steps: ### 1. Click the Top Up button @@ -36,7 +31,7 @@ You can check for pending payment sessions on the **Billing page**, in the **Pay ### 2. Enter the amount you want to top up your Balance with :::info -Currently, the minimum top up amount is **USDC 10.00** while your total balance cannot exceed **USDC 5000.00**. +Currently, the minimum top up amount is **USDC 10.00**, while your total Balance amount cannot exceed **USDC 5000.00**. ::: ![enter amount](./assets/amount.webp) @@ -65,14 +60,14 @@ If you encounter issues with the “Wallet” payment option, we recommend using ::: ![complete payment](./assets/complete_payment.webp) -### 5. Back to Fluence Console +### 5. Return to the Fluence Console After a successful payment, you will be redirected back to the **Fluence Console** page. The payment will be in the `Pending` status for a bit. :::info -At this time, you cannot have multiple pending Balance top-up operations. If you cannot complete a CopperX payment and don't want to wait 15 minutes, you need to [cancel to the payment](#cancel-payment). +You cannot have multiple `Pending` transactions. If you cannot complete a CopperX payment and don't want to wait 15 minutes, you need to [cancel to the payment](#cancel-payment). ::: -### 6. Wait for "Completed" payment status +### 6. Wait for the "Completed" payment status Once the on-chain transactions are processed, the Balance smart contract will reflect your payment and the FLuence Console payment status updates to `Completed`. From c33c7d17c71f68f0ea5367c685636a3540b10c6b Mon Sep 17 00:00:00 2001 From: boneyard93501 <4523011+boneyard93501@users.noreply.github.com.> Date: Tue, 18 Feb 2025 14:20:54 -0600 Subject: [PATCH 5/7] edits --- docs/build/vm_rent/vm_rent.md | 40 +++++++++++++++++------------------ 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/build/vm_rent/vm_rent.md b/docs/build/vm_rent/vm_rent.md index d46832f..d9a569b 100644 --- a/docs/build/vm_rent/vm_rent.md +++ b/docs/build/vm_rent/vm_rent.md @@ -1,12 +1,12 @@ -# Renting a VM +# Renting A VM -The Fluence marketplace is a decentralized broker of compute supply and demand governed by a set of smart contracts. To this end, the Fluence marketplace not only facilitates the renting process of a VM between you and one of the participating compute providers but also the configuration and management of your VM. +The Fluence marketplace is a decentralized broker of compute supply and demand governed by a set of smart contracts. To this end, the Fluence marketplace not only facilitates the renting process of VMs between you and the participating compute provider(s) but also the configuration and management of your VMs. -Currently, there are several limitation concerning VM rental: +Currently, there are a couple of limitations with respect renting VMs: -1. A VM can only be rented for a limited period of time. This current limitation is due implementation specifics of the verification, i.e., capacity commitment, and security, i.e., staking, protocols. The exact maximum rental period for a VM can be seen in the Fluence Console. +1. A VM can only be rented for a limited period of time. This limitation is due to the implementation specifics of the verification, i.e., capacity commitment, and security, i.e., staking, protocols. The exact maximum rental period for a VM can be seen in the Fluence Console. -2. When renting a VM, a prepayment amount equivalent to one day’s rent is deducted from your Balance to cover the next day’s rent. This amount is refunded to your Balance when the rental period ends, unless your balance runs out and the prepaid amount is used to cover that day's VM cost. You can check the amount of your Balance reserved as a “prepayment” on the Billing page in the Fluence Console. +2. When renting a VM, a prepayment amount equivalent to one day’s rent is deducted from your Balance to cover the next day’s rent. This amount is refunded to your Balance when the rental period ends, unless your available Balance amount is too low in which case the prepaid amount is used to cover that day's rent. You can check the amount of your Balance reserved as a “prepayment” on the Billing page in the Fluence Console. :::warning If your Balance does not have enough funds to pay for the next day's rent, the previously deducted prepayment will be used to cover the rent. After the reserved funds are exhausted and you fail to top up o Balance in time, the VM's rental agreement will be terminated and the VM will be automatically deleted. @@ -16,13 +16,13 @@ If your Balance does not have enough funds to pay for the next day's rent, the p The Fluence marketplace aggregates enterprise-grade compute resources from predominantly Tier-3 and Tier-4 data centers around the world. To rent a VM: -### 1. Choose location +### 1. Choose a location Choose one of the available data center locations. ![choose location](./assets/location.webp) -### 2. Choose configuration +### 2. Choose a configuration Choose your VM's configuration from the available options. Currently, compute resources can only be rented in multiples of a compute unit, which is 2 vCPUs and 4 GB of RAM. In the future, this limitation will be removed and compute resources can be added in a fine-grained manner for both vCPUs and RAM. @@ -37,31 +37,31 @@ Choose the type and amount of storage desired. Currently, the minimum storage si ### 4. Choose the server type -Specify the Server type for the VM. Since hardware within and across data centers may vary, pay close attention to the available hardware specifications and price. Moreover, Fluence Console allows you to view a data center's geo location at the city level and other important details such as available certifications. +Specify the server type for the VM. Since hardware within and across data centers may vary, pay close attention to the provided hardware specifications and price. Moreover, Fluence Console allows you to view a data center's geo location at the city level and other important details such as available certifications and you are encourage to utilize these resources. ![choose server type](./assets/server_type.webp) :::info -The choice of **Server type** also affects the rental duration of the VM. Pay attention to the `Expires in` parameter in the **Review** block. If you are not satisfied with the length of the rental period, you can try selecting a different Server type. +**Server type** may affect the available rental duration of the VM. Pay attention to the `Expires in` parameter in the **Review** block and ff you are not satisfied with the length of the rental period, try selecting a different server type. ::: ### 5. Rent a Public IPv4 address -Currently, you can only access yor VM via SSH over the public IPv4 allocated to the VM. In the future, the requirement for a Public IPv4 to access a VM will be removed. +Currently, you can only access yor VM via SSH over the public IPv4 allocated to the VM at instantiation. In the future, this requirement will be removed. ![rent public IPv4 address](./assets/public_ip.webp) -Yu are now ready to configure your VM. +You are now ready to configure your VM. -### 6. Specify VM name +### 6. Specify the VM name Specify a **name for the VM**. Currently, the VM name must be unique within a your (user) account. ![specify VM name](./assets/vm_name.webp) -### 7. Specify the ports +### 7. Specify the open ports -Specify the ports you want opened at startup. By default, all ports except **port 22** are closed. Note that all open ports support **TCP** and **UDP** and you can open up to 50 ports. +By default, all ports except **port 22** are closed but you can assign up to 50 open ports for your VM and all open ports support **TCP** and **UDP**. :::info Currently, it is not possible to change the set of open ports through **Fluence Console** after the VM is initiated. While you are able to configure your own Firewall and **close** ports originally asked to be opened, you will not be able to **open** ports not specified to be open at VM creation. @@ -71,26 +71,26 @@ Currently, it is not possible to change the set of open ports through **Fluence ### 8. Choose the OS image -Choose the **OS image** for your VM. You can either choose a pre-defined OS image or provide a link to a **custom OS image**. Note that a custom OS image must be available for download from publicly accessible link and must be configured for running on remote instances. The Fluence team recommends choosing images with the `Generic Cloud` or `Cloud` tags. +Choose the **OS image** for your VM. You can either choose a pre-defined OS image or provide a link to a **custom OS image**. Only use custom OS images available for download from a publicly accessible link and configured to run on remote instances. The Fluence team recommends choosing (custom) images with the `Generic Cloud` or `Cloud` tags. ![choose OS image](./assets/os_image.webp) ### 9. Provide the public SSH key -Provide the public SSH key for connecting to the VM. You need to specify at least one SSH key in either RSA, ECDSA or ED25519 format. +Provide the public SSH key you want to use to connect to your VM. You need to provide at least one SSH key in either RSA, ECDSA or ED25519 format. ![provide SSH key](./assets/ssh.webp) ### 10. Review the summary -After selecting all the VM parameters, you can see the instance summary and price in the Review section. +After selecting all the VM parameters, check and review the instance summary and price in the Review section. ![review summary](./assets/summary.webp) ### 11. Launch the VM -Click the “Launch” button to rent the VM and you will be redirected to the Running Instances page. +Click the “Launch” button to rent the VM after which you will be redirected to the Running Instances page. -:::warning -Please note payment for VMs occurs every day at **`5:55 PM UTC`** and currently only possible for full days regardless of the rental start time. Thus, if you rent a VM at `5:45 PM UTC`, you will pay for a **FULL** day for ten minutes of use. At `5:55 PM UTC`, the next full payment is due. This limitation is also expected to be remedied in the near future. +:::info +Please note payment for VMs occurs every day at **`5:55 PM UTC`** and is currently only possible for full days regardless of the rental start time. Thus, if you rent a VM at `5:45 PM UTC`, you will pay for a **FULL** day for the ten minutes of use. At `5:55 PM UTC`, the next full payment is due. This limitation is expected to be remedied in the very near future. ::: From 342cf73b7ed959ae4cfe65351c8b209d51b0780f Mon Sep 17 00:00:00 2001 From: boneyard93501 <4523011+boneyard93501@users.noreply.github.com.> Date: Tue, 18 Feb 2025 14:24:06 -0600 Subject: [PATCH 6/7] edits --- docs/build/manage_vm/manage_vm.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/build/manage_vm/manage_vm.md b/docs/build/manage_vm/manage_vm.md index aaa8cfc..ed7cb3d 100644 --- a/docs/build/manage_vm/manage_vm.md +++ b/docs/build/manage_vm/manage_vm.md @@ -4,8 +4,7 @@ After renting a VM, all the relevant information is accessible on the **Running ## VM Information -After renting a VM, a corresponding card will appear on the **Running Instances** page, which can be expanded to view all the parameters of the rented VM and detailed information can be found in the `Hardware Specs` section. Note that -the extended server parameters are only visible if the specific infrastructure provider has provided this necessary information. +For each VM, a corresponding card will appear on the **Running Instances** page, which can be expanded. More detailed information can be found in the `Hardware Specs` section. Note that extended server parameters are only visible if the specific infrastructure provider has provided the underlying information. ![VM information](./assets/vm_info.webp) @@ -13,7 +12,7 @@ The user can also see the maximum rental period for the VM (`Expires in`) and in ## VM Management -Currently, the only operation available for a running VM is `Delete`, which terminates the VM and the rental agreement. The ability to Reboot, Reset, and Rebuild from the Fluence Console will be added soon. +Currently, the only operation available for a (running) VM is `Delete`, which terminates the VM and the rental agreement. The ability to Reboot, Reset and Rebuild from the Fluence Console will be added soon. ![VM management](./assets/vm_manage.webp) From f7039024027ca3a9ed8192c98c403ad8863471bf Mon Sep 17 00:00:00 2001 From: boneyard93501 <4523011+boneyard93501@users.noreply.github.com.> Date: Tue, 18 Feb 2025 14:28:22 -0600 Subject: [PATCH 7/7] edits --- docs/build/settings/settings.md | 8 ++++---- docs/build/vm_rent/vm_rent.md | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/build/settings/settings.md b/docs/build/settings/settings.md index ac5906f..2b68e0f 100644 --- a/docs/build/settings/settings.md +++ b/docs/build/settings/settings.md @@ -4,15 +4,15 @@ Use the **Settings** page to manage your SSH and API keys and more. ## SSH Keys -On **SSH keys** page, you can: -1. Creating a new key. Currently, the following SSH key formats are supported: RSA, ECDSA, and ED25519. -2. Deleting existing keys. +On the **SSH keys** page, you can: +1. Create a new key of any of the RSA, ECDSA or ED25519 format. +2. Delete existing keys. ![SSH keys page](./assets/ssh_keys.webp) ## API Keys -Instead of using the **Fluence Console**, yo cna manage your resources also through the **Public API**. +Instead of using the **Fluence Console**, you can manage your resources also through our **Public API**. :::info In the first stage of the **Alpha VM testing**, you will not have access to the **Public API**. The Fluence team will notify you when this functionality becomes available. diff --git a/docs/build/vm_rent/vm_rent.md b/docs/build/vm_rent/vm_rent.md index d9a569b..9de3407 100644 --- a/docs/build/vm_rent/vm_rent.md +++ b/docs/build/vm_rent/vm_rent.md @@ -6,7 +6,7 @@ Currently, there are a couple of limitations with respect renting VMs: 1. A VM can only be rented for a limited period of time. This limitation is due to the implementation specifics of the verification, i.e., capacity commitment, and security, i.e., staking, protocols. The exact maximum rental period for a VM can be seen in the Fluence Console. -2. When renting a VM, a prepayment amount equivalent to one day’s rent is deducted from your Balance to cover the next day’s rent. This amount is refunded to your Balance when the rental period ends, unless your available Balance amount is too low in which case the prepaid amount is used to cover that day's rent. You can check the amount of your Balance reserved as a “prepayment” on the Billing page in the Fluence Console. +2. When renting a VM, a prepayment amount equivalent to one day’s rent is deducted from your Balance to cover the next day’s rent. This amount is refunded to your Balance when the rental period ends, unless your available Balance amount is too low in which case the prepaid amount is used to cover that day's rent. You can check the amount of your Balance reserved as a “prepayment” on the **Billing** page in the Fluence Console. :::warning If your Balance does not have enough funds to pay for the next day's rent, the previously deducted prepayment will be used to cover the rent. After the reserved funds are exhausted and you fail to top up o Balance in time, the VM's rental agreement will be terminated and the VM will be automatically deleted. @@ -89,7 +89,7 @@ After selecting all the VM parameters, check and review the instance summary and ### 11. Launch the VM -Click the “Launch” button to rent the VM after which you will be redirected to the Running Instances page. +Click the “Launch” button to rent the VM after which you will be redirected to the **Running Instances** page. :::info Please note payment for VMs occurs every day at **`5:55 PM UTC`** and is currently only possible for full days regardless of the rental start time. Thus, if you rent a VM at `5:45 PM UTC`, you will pay for a **FULL** day for the ten minutes of use. At `5:55 PM UTC`, the next full payment is due. This limitation is expected to be remedied in the very near future.