diff --git a/books/manual/SUMMARY.md b/books/manual/SUMMARY.md index b774903..4377d7c 100644 --- a/books/manual/SUMMARY.md +++ b/books/manual/SUMMARY.md @@ -202,6 +202,7 @@ - [Web Gateway](system_administrators/terraform/resources/terraform_vm_gateway.md) - [Kubernetes Cluster](system_administrators/terraform/resources/terraform_k8s.md) - [ZDB](system_administrators/terraform/resources/terraform_zdb.md) + - [Zlogs](system_administrators/terraform/resources/terraform_zlogs.md) - [Quantum Safe Filesystem](system_administrators/terraform/resources/terraform_qsfs.md) - [QSFS on Micro VM](system_administrators/terraform/resources/terraform_qsfs_on_microvm.md) - [QSFS on Full VM](system_administrators/terraform/resources/terraform_qsfs_on_full_vm.md) @@ -248,6 +249,7 @@ - [Cancel Contracts](system_administrators/advanced/cancel_contracts.md) - [Contract Bills Reports](system_administrators/advanced/contract_bill_report.md) - [Listing Free Public IPs](system_administrators/advanced/list_public_ips.md) + - [Cloud Console](system_administrators/advanced/cloud_console.md) - [Redis](system_administrators/advanced/grid3_redis.md) - [IPFS](system_administrators/advanced/ipfs/ipfs_toc.md) - [IPFS on a Full VM](system_administrators/advanced/ipfs/ipfs_fullvm.md) diff --git a/collections/system_administrators/advanced/advanced.md b/collections/system_administrators/advanced/advanced.md index 0edb6dd..79aff8b 100644 --- a/collections/system_administrators/advanced/advanced.md +++ b/collections/system_administrators/advanced/advanced.md @@ -8,6 +8,7 @@ In this section, we delve into sophisticated topics and powerful functionalities - [Cancel Contracts](cancel_contracts.md) - [Contract Bills Reports](contract_bill_report.md) - [Listing Free Public IPs](list_public_ips.md) +- [Cloud Console](cloud_console.md) - [Redis](grid3_redis.md) - [IPFS](ipfs_toc.md) - [IPFS on a Full VM](ipfs_fullvm.md) diff --git a/collections/system_administrators/advanced/cloud_console.md b/collections/system_administrators/advanced/cloud_console.md new file mode 100644 index 0000000..ee8d15e --- /dev/null +++ b/collections/system_administrators/advanced/cloud_console.md @@ -0,0 +1,33 @@ +

Cloud Console

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Overview](#overview) +- [Connect to Cloud Console](#connect-to-cloud-console) + +--- + +## Introduction + +Cloud console is a tool to view machine logging and interact with the machine you have deployed. We show the basics of cloud-console and how to access it via a browser during deployment. + +## Overview + +Cloud console always runs on the machine's private network ip and port number equla to `20000 +last octect` of machine private IP. For example if the machine ip is `10.20.2.2/24`, this means that `cloud-console` is running on `10.20.2.1:20002`. + +For the cloud-console to run we need to start the cloud-hypervisor with option "--serial pty" instead of tty, this allows us to interact with the vm from another process, `cloud-console` in our case. + +## Connect to Cloud Console + +You can easily connect to cloud console on the TFGrid. + +- Deploy a VM on the TFGrid with the WireGuard network +- Set the WireGuard configuration file +- Start the WireGuard connection: + ``` + wg-quick up wireguard.conf + ``` +- Go to your browser with the network router IP `10.20.2.1:20002` to access cloud console. + +> Note: You might need to create a user/password in the VM first before connecting to cloud-console if the image used does not have a default user. \ No newline at end of file diff --git a/collections/system_administrators/system_administrators.md b/collections/system_administrators/system_administrators.md index cea89ac..94872c2 100644 --- a/collections/system_administrators/system_administrators.md +++ b/collections/system_administrators/system_administrators.md @@ -32,6 +32,7 @@ For complementary information on ThreeFold grid and its cloud component, refer t - [Web Gateway](terraform_vm_gateway.md) - [Kubernetes Cluster](terraform_k8s.md) - [ZDB](terraform_zdb.md) + - [Zlogs](terraform_zlogs.md) - [Quantum Safe Filesystem](terraform_qsfs.md) - [QSFS on Micro VM](terraform_qsfs_on_microvm.md) - [QSFS on Full VM](terraform_qsfs_on_full_vm.md) @@ -78,6 +79,7 @@ For complementary information on ThreeFold grid and its cloud component, refer t - [Cancel Contracts](cancel_contracts.md) - [Contract Bills Reports](contract_bill_report.md) - [Listing Free Public IPs](list_public_ips.md) + - [Cloud Console](cloud_console.md) - [Redis](grid3_redis.md) - [IPFS](ipfs_toc.md) - [IPFS on a Full VM](ipfs_fullvm.md) diff --git a/collections/system_administrators/terraform/resources/terraform_resources_readme.md b/collections/system_administrators/terraform/resources/terraform_resources_readme.md index abf43bc..ed8e50a 100644 --- a/collections/system_administrators/terraform/resources/terraform_resources_readme.md +++ b/collections/system_administrators/terraform/resources/terraform_resources_readme.md @@ -7,6 +7,7 @@ - [Web Gateway](./terraform_vm_gateway.html) - [Kubernetes Cluster](./terraform_k8s.html) - [ZDB](./terraform_zdb.html) +- [Zlogs](./terraform_zlogs.md) - [Quantum Safe Filesystem](terraform_qsfs.md) - [QSFS on Micro VM](terraform_qsfs_on_microvm.md) - [QSFS on Full VM](terraform_qsfs_on_full_vm.md) diff --git a/collections/system_administrators/terraform/resources/terraform_zlogs.md b/collections/system_administrators/terraform/resources/terraform_zlogs.md index 1867ce4..7ed64e8 100644 --- a/collections/system_administrators/terraform/resources/terraform_zlogs.md +++ b/collections/system_administrators/terraform/resources/terraform_zlogs.md @@ -1,10 +1,21 @@ -# Zlogs +

Zlogs

+ +

Table of Contents

+ +- [Introduction](#introduction) +- [Using Zlogs](#using-zlogs) + - [Creating a server](#creating-a-server) + - [Streaming logs](#streaming-logs) + +--- + +## Introduction Zlogs is a utility that allows you to stream VM logs to a remote location. You can find the full description [here](https://github.com/threefoldtech/zos/tree/main/docs/manual/zlogs) ## Using Zlogs -In terraform, a vm has a zlogs field, this field should contain a list of target URLs to stream logs to. +In Terraform, a vm has a zlogs field, this field should contain a list of target URLs to stream logs to. Valid protocols are: `ws`, `wss`, and `redis`. @@ -104,5 +115,4 @@ asyncio.run(main()) ``` exec: sh -c "echo 'to be streamed'" log: stdout -``` - +``` \ No newline at end of file diff --git a/collections/system_administrators/terraform/terraform_toc.md b/collections/system_administrators/terraform/terraform_toc.md index dbccb0c..16c7724 100644 --- a/collections/system_administrators/terraform/terraform_toc.md +++ b/collections/system_administrators/terraform/terraform_toc.md @@ -13,7 +13,11 @@ - [Web Gateway](terraform_vm_gateway.md) - [Kubernetes Cluster](terraform_k8s.md) - [ZDB](terraform_zdb.md) + - [Zlogs](terraform_zlogs.md) - [Quantum Safe Filesystem](terraform_qsfs.md) + - [QSFS on Micro VM](terraform_qsfs_on_microvm.md) + - [QSFS on Full VM](terraform_qsfs_on_full_vm.md) + - [CapRover](terraform_caprover.md) - [QSFS on Micro VM](terraform_qsfs_on_microvm.md) - [QSFS on Full VM](terraform_qsfs_on_full_vm.md) - [CapRover](terraform_caprover.md)