admin/3engines_doc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

brand changed

Browse Source
This commit is contained in:
govardhan
2025-07-04 09:34:25 +05:30
parent 1ee37aea8b
commit faadd4e38d
129 changed files with 1069 additions and 1068 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/openstackcli/3Enginescli.html.md Normal file
View File

@ -0,0 +1,19 @@
# 3Engines CLI
## Available Documentation
* [How to Backup an Instance and Download it to the Desktop on 3Engines Cloud 3Engines Hosting](How-to-backup-an-instance-and-download-it-to-the-desktop-on-3Engines-Cloud.html.md)
* [How to create a set of VMs using 3Engines Heat Orchestration on 3Engines Cloud](How-to-create-a-set-of-VMs-using-3Engines-Heat-Orchestration-on-3Engines-Cloud.html.md)
* [How to Create and Configure New 3Engines Project Through Horizon on 3Engines Cloud Cloud](How-To-Create-and-Configure-New-Project-on-3Engines-Cloud-Cloud.html.md)
* [How to install 3EnginesClient for Linux on 3Engines Cloud](How-to-install-3EnginesClient-for-Linux-on-3Engines-Cloud.html.md)
* [How to install 3EnginesClient GitBash for Windows on 3Engines Cloud](How-to-install-3EnginesClient-GitBash-or-Cygwin-for-Windows-on-3Engines-Cloud.html.md)
* [How to share private container from object storage to another user on 3Engines Cloud](How-to-share-private-container-from-object-storage-to-another-user-on-3Engines-Cloud.html.md)
* [How to install 3EnginesClient on Windows using Windows Subsystem for Linux on 3Engines Cloud 3Engines Hosting](How-to-install-3EnginesClient-on-Windows-using-Windows-Subsystem-for-Linux-on-3Engines-Cloud-3Engines-Hosting.html.md)
* [How to move data volume between VMs using 3Engines CLI on 3Engines Cloud](How-to-move-data-volume-between-two-VMs-using-3Engines-CLI-on-3Engines-Cloud.html.md)
* [How to access object storage using 3Engines CLI on 3Engines Cloud](How-to-access-object-storage-using-3Engines-CLI-on-3Engines-Cloud.html.md)
* [How to transfer volumes between domains and projects using 3Engines CLI client on 3Engines Cloud](How-to-transfer-volumes-between-domains-and-projects-using-3Engines-CLI-client-on-3Engines-Cloud.html.md)
* [How to start a VM from instance snapshot using 3Engines CLI on 3Engines Cloud](How-to-start-a-VM-from-instance-snapshot-using-3Engines-CLI-on-3Engines-Cloud.html.md)
* [How to create instance snapshot using 3Engines CLI on 3Engines Cloud](How-to-create-instance-snapshot-using-3Engines-CLI-on-3Engines-Cloud.html.md)
* [Resizing a virtual machine using 3Engines CLI on 3Engines Cloud](Resizing-a-virtual-machine-using-3Engines-CLI-on-3Engines-Cloud.html.md)
* [Use backup command to create rotating backups of virtual machines on 3Engines Cloud cloud](Use-backup-command-to-create-rotating-backups-of-virtual-machines-on-3Engines-Cloud.html.md)
* [Use script to create daily weekly and monthly rotating backups of virtual machines on 3Engines Cloud](Use-script-to-create-daily-weekly-and-monthly-rotating-backups-of-virtual-machines-using-on-3Engines-Cloud.html.md)

8
docs/openstackcli/How-To-Create-and-Configure-New-Project-on-3Engines-Cloud-Cloud.html.md
View File

@ -1,4 +1,4 @@
How to Create and Configure New Openstack Project Through Horizon on 3Engines Cloud Cloud[🔗](#how-to-create-and-configure-new-openstack-project-through-horizon-on-brand-name-cloud-name-cloud "Permalink to this headline")
How to Create and Configure New 3Engines Project Through Horizon on 3Engines Cloud Cloud[🔗](#how-to-create-and-configure-new-3Engines-project-through-horizon-on-brand-name-cloud-name-cloud "Permalink to this headline")
==============================================================================================================================================================================================================================
Default elements of the account[🔗](#default-elements-of-the-account "Permalink to this headline")
@ -11,7 +11,7 @@ When you first create your account at 3Engines Cloud hosting, default values for
> * three networks and
> * two security groups.
In OpenStack terminology, the role of **tenant manager** is to be an administrator of the account. As a tenant manager, you can
In 3Engines terminology, the role of **tenant manager** is to be an administrator of the account. As a tenant manager, you can
> * use the account directly but can also
> * create other users od the account.
@ -32,9 +32,9 @@ No. 1 **Hosting**
You need a 3Engines Cloud hosting account with Horizon interface <https://horizon.3Engines.com>.
No. 2 **Introduction to OpenStack Projects**
No. 2 **Introduction to 3Engines Projects**
The article [What is an OpenStack project on 3Engines Cloud](../cloud/What-is-an-OpenStack-project-on-3Engines-Cloud.html.md) will define basic elements of an OpenStack project – groups, projects, roles and so on.
The article [What is an 3Engines project on 3Engines Cloud](../cloud/What-is-an-3Engines-project-on-3Engines-Cloud.html.md) will define basic elements of an 3Engines project – groups, projects, roles and so on.
No. 3 **Security groups**

24
docs/openstackcli/How-to-access-object-storage-using-OpenStack-CLI-on-3Engines-Cloud.html.md → docs/openstackcli/How-to-access-object-storage-using-3Engines-CLI-on-3Engines-Cloud.html.md
View File

@ -1,22 +1,22 @@
How to access object storage using OpenStack CLI on 3Engines Cloud[🔗](#how-to-access-object-storage-using-openstack-cli-on-brand-name "Permalink to this headline")
How to access object storage using 3Engines CLI on 3Engines Cloud[🔗](#how-to-access-object-storage-using-3Engines-cli-on-brand-name "Permalink to this headline")
=====================================================================================================================================================================
Cloud computing offers the ability to handle large chunks of data, directly on the remote server. OpenStack module [Swift](https://docs.openstack.org/swift/latest/) was created expressly to enable access to unstructured data that can grow without bounds, with the following design goals in mind :
Cloud computing offers the ability to handle large chunks of data, directly on the remote server. 3Engines module [Swift](https://docs.3Engines.org/swift/latest/) was created expressly to enable access to unstructured data that can grow without bounds, with the following design goals in mind :
> * durability,
> * scalability,
> * concurrency across the entire data set,
> * all while keeping the API simple.
**Swift** is installed as an independent module but on the syntax level, it is used through the parameters of **openstack** command.
**Swift** is installed as an independent module but on the syntax level, it is used through the parameters of **3Engines** command.
What We Are Going To Cover[🔗](#what-we-are-going-to-cover "Permalink to this headline")
---------------------------------------------------------------------------------------
> * How to install Swift
> * How to connect Swift to OpenStack cloud
> * Basic openstack operations with containers
> * Basic openstack operations with objects
> * How to connect Swift to 3Engines cloud
> * Basic 3Engines operations with containers
> * Basic 3Engines operations with objects
Prerequisites[🔗](#prerequisites "Permalink to this headline")
-------------------------------------------------------------
@ -25,24 +25,24 @@ No. 1 **Hosting**
You need a 3Engines Cloud hosting account, available at <https://portal.3Engines.com/>. If you want to follow up with articles about object storage on Horizon, you will this link too: <https://horizon.3Engines.com>.
No. 2 **Install or activate openstack command**
No. 2 **Install or activate 3Engines command**
To be able to connect to the cloud, **openstack** command must be operational. If not installed already, use article [How to install OpenStackClient for Linux on 3Engines Cloud](How-to-install-OpenStackClient-for-Linux-on-3Engines-Cloud.html.md)
To be able to connect to the cloud, **3Engines** command must be operational. If not installed already, use article [How to install 3EnginesClient for Linux on 3Engines Cloud](How-to-install-3EnginesClient-for-Linux-on-3Engines-Cloud.html.md)
No. 3 **Authenticate to OpenStack using application credentials**
No. 3 **Authenticate to 3Engines using application credentials**
Then you have to authenticate your account to the cloud. The usual way is to activate **openstack** command using an RC file for on- or two-factor
Then you have to authenticate your account to the cloud. The usual way is to activate **3Engines** command using an RC file for on- or two-factor
authentication. That will not work in case of Swift module. It is authenticated with application credentials, as explained in article
[How to generate or use Application Credentials via CLI on 3Engines Cloud](../cloud/How-to-generate-or-use-Application-Credentials-via-CLI-on-3Engines-Cloud.html.md).
No. 4 **Familiarity with object storage on** 3Engines Cloud **OpenStack**
No. 4 **Familiarity with object storage on** 3Engines Cloud **3Engines**
This article is explaining the basics, using the Horizon interface:
[How to use Object Storage on 3Engines Cloud](../s3/How-to-use-Object-Storage-on-3Engines-Cloud.html.md).
Swift can be understood as the CLI tool for accessing object storage under OpenStack.
Swift can be understood as the CLI tool for accessing object storage under 3Engines.
No. 5 **Python installed**

20
docs/openstackcli/How-to-backup-an-instance-and-download-it-to-the-desktop-on-3Engines-Cloud.html.md
View File

@ -1,11 +1,11 @@
How to Backup an Instance and Download it to the Desktop on 3Engines Cloud OpenStack Hosting[🔗](#how-to-backup-an-instance-and-download-it-to-the-desktop-on-brand-name-openstack-hosting "Permalink to this headline")
How to Backup an Instance and Download it to the Desktop on 3Engines Cloud 3Engines Hosting[🔗](#how-to-backup-an-instance-and-download-it-to-the-desktop-on-brand-name-3Engines-hosting "Permalink to this headline")
=========================================================================================================================================================================================================================
First, you will need to setup the OpenStack CLI environment on the computer to which you want to download your instance. Depending on the operating system you are using, follow one of the links below:
First, you will need to setup the 3Engines CLI environment on the computer to which you want to download your instance. Depending on the operating system you are using, follow one of the links below:
[How to install OpenStackClient for Linux on 3Engines Cloud](How-to-install-OpenStackClient-for-Linux-on-3Engines-Cloud.html.md)
[How to install 3EnginesClient for Linux on 3Engines Cloud](How-to-install-3EnginesClient-for-Linux-on-3Engines-Cloud.html.md)
[How to install OpenStackClient GitBash for Windows on 3Engines Cloud](How-to-install-OpenStackClient-GitBash-or-Cygwin-for-Windows-on-3Engines-Cloud.html.md)
[How to install 3EnginesClient GitBash for Windows on 3Engines Cloud](How-to-install-3EnginesClient-GitBash-or-Cygwin-for-Windows-on-3Engines-Cloud.html.md)
Assume that you are
@ -20,7 +20,7 @@ List Instances in Your Project[🔗](#list-instances-in-your-project "Permalink
List instances in your project using the following CLI command:
```
user@ubuntu:~$ openstack server list
user@ubuntu:~$ 3Engines server list
```
@ -37,7 +37,7 @@ Create a Backup[🔗](#create-a-backup "Permalink to this headline")
Now you can create a backup from command line interface (CLI) in the terminal (replace **72170eb7-cee4-41a3-beea-c7d208446130** with the ID of your instance):
```
user@ubuntu:~$ openstack server backup create --name backup-01 72170eb7-cee4-41a3-beea-c7d208446130
user@ubuntu:~$ 3Engines server backup create --name backup-01 72170eb7-cee4-41a3-beea-c7d208446130
```
@ -46,7 +46,7 @@ Note
You can also add the **–rotate<count>** parameter to the above command if you want to have control over the number of stored backups:
```
user@ubuntu:~$ openstack server backup create --name backup-01 --rotate 2 72170eb7-cee4-41a3-beea-c7d208446130
user@ubuntu:~$ 3Engines server backup create --name backup-01 --rotate 2 72170eb7-cee4-41a3-beea-c7d208446130
```
@ -57,7 +57,7 @@ You can see the backup “backup-01” in <https://horizon.3Engines.com/project/
or with CLI command:
```
user@ubuntu:~$ openstack image list --private
user@ubuntu:~$ 3Engines image list --private
```
@ -78,7 +78,7 @@ Download the Backup File[🔗](#download-the-backup-file "Permalink to this head
Disk image is a raw copy of the hard drive of your virtual machine. You can download it using the following command (replace **72170eb7-cee4-41a3-beea-c7d208446130** with the ID of your disk image):
```
user@ubuntu:~$ openstack image save --file backup-on-the-desktop 747d720d-a6f4-4554-bf56-16183e5fb7fa
user@ubuntu:~$ 3Engines image save --file backup-on-the-desktop 747d720d-a6f4-4554-bf56-16183e5fb7fa
```
@ -102,6 +102,6 @@ On this panel you must insert image name, choose backup file and backup format.
You can also use CLI commands to upload the backup file:
```
user@ubuntu:~$ openstack image create --file path/to/backup <backup_name>
user@ubuntu:~$ 3Engines image create --file path/to/backup <backup_name>
```

26
docs/openstackcli/How-to-create-a-set-of-VMs-using-OpenStack-Heat-Orchestration-on-3Engines-Cloud.html.md → docs/openstackcli/How-to-create-a-set-of-VMs-using-3Engines-Heat-Orchestration-on-3Engines-Cloud.html.md
View File

@ -1,9 +1,9 @@
How to create a set of VMs using OpenStack Heat Orchestration on 3Engines Cloud[🔗](#how-to-create-a-set-of-vms-using-openstack-heat-orchestration-on-brand-name "Permalink to this headline")
How to create a set of VMs using 3Engines Heat Orchestration on 3Engines Cloud[🔗](#how-to-create-a-set-of-vms-using-3Engines-heat-orchestration-on-brand-name "Permalink to this headline")
===============================================================================================================================================================================================
Heat is an OpenStack component responsible for Orchestration. Its purpose is to deliver automation engine and optimize processes.
Heat is an 3Engines component responsible for Orchestration. Its purpose is to deliver automation engine and optimize processes.
Heat receives commands through templates which are text files in *yaml* format. A template describes the entire infrastructure that you want to deploy. The deployed environment is called a *stack* and can consist of any combination out of the **102** different resources that are available in OpenStack.
Heat receives commands through templates which are text files in *yaml* format. A template describes the entire infrastructure that you want to deploy. The deployed environment is called a *stack* and can consist of any combination out of the **102** different resources that are available in 3Engines.
What We Are Going To Cover[🔗](#what-we-are-going-to-cover "Permalink to this headline")
---------------------------------------------------------------------------------------
@ -26,14 +26,14 @@ No. 2 **Installed Python and its virtualenv**
If you want to use Heat through CLI commands, Python must be installed and its virtual environment activated. See article [How to install Python virtualenv or virtualenvwrapper on 3Engines Cloud](../cloud/How-to-install-Python-virtualenv-or-virtualenvwrapper-on-3Engines-Cloud.html.md).
If you have never installed one of the OpenStack clients, see :[How To Install OpenStack and Magnum Clients for Command Line Interface to 3Engines Cloud Horizon](../kubernetes/How-To-Install-OpenStack-and-Magnum-Clients-for-Command-Line-Interface-to-3Engines-Cloud-Horizon.html.md).
If you have never installed one of the 3Engines clients, see :[How To Install 3Engines and Magnum Clients for Command Line Interface to 3Engines Cloud Horizon](../kubernetes/How-To-Install-3Engines-and-Magnum-Clients-for-Command-Line-Interface-to-3Engines-Cloud-Horizon.html.md).
Always use the latest value of image id[🔗](#always-use-the-latest-value-of-image-id "Permalink to this headline")
-----------------------------------------------------------------------------------------------------------------
From time to time, the default images of operating systems in the 3Engines Cloud cloud are upgraded to the new versions. As a consequence, their **image id** will change. Let’s say that the image id for Ubuntu 20.04 LTS was **574fe1db-8099-4db4-a543-9e89526d20ae** at the time of writing of this article. While working through the article, you would normally take the **current** value of image id, and would use it to replace **574fe1db-8099-4db4-a543-9e89526d20ae** throughout the text.
Now, suppose you wanted to automate processes under OpenStack, perhaps using Heat, Terraform, Ansible or any other tool for OpenStack automation; if you use the value of **574fe1db-8099-4db4-a543-9e89526d20ae** for image id, it would remain **hardcoded** and once this value gets changed during the upgrade, the automated process may stop to execute.
Now, suppose you wanted to automate processes under 3Engines, perhaps using Heat, Terraform, Ansible or any other tool for 3Engines automation; if you use the value of **574fe1db-8099-4db4-a543-9e89526d20ae** for image id, it would remain **hardcoded** and once this value gets changed during the upgrade, the automated process may stop to execute.
Warning
@ -82,7 +82,7 @@ Here are the basic elements of a Heat template:
: Name of resource (you can type in anything on your own).
**type**
: Definition of an OpenStack component (a comprehensive list is under **Orchestration** -> **Resource Types**)
: Definition of an 3Engines component (a comprehensive list is under **Orchestration** -> **Resource Types**)
**properties**
: Required parameters for deploying a component.
@ -94,7 +94,7 @@ Your account will normally have a network starting with **cloud\_** but it may a
How to get data for Heat template[🔗](#how-to-get-data-for-heat-template "Permalink to this headline")
-----------------------------------------------------------------------------------------------------
Templates need data for images, flavor networks, key pairs, security groups and so on. You would normally know all these elements in advance, or you could “look around” at various parts of OpenStack environment:
Templates need data for images, flavor networks, key pairs, security groups and so on. You would normally know all these elements in advance, or you could “look around” at various parts of 3Engines environment:
| | |
| --- | --- |
@ -127,7 +127,7 @@ pip install python-heatclient
To run a prepared template in order to deploy a stack, this is what a general command would look like:
```
openstack stack create -t template.yaml <stackname>
3Engines stack create -t template.yaml <stackname>
```
@ -136,7 +136,7 @@ where **-t** assigns template for deployment and **<stackname>** defines name fo
As a result, a new Stack would be executed and a new instance would be created. For example, the command
```
openstack stack create -t template.yaml heat-test2
3Engines stack create -t template.yaml heat-test2
```
@ -169,7 +169,7 @@ Enter the text of the template you copied from file **template.yaml** directly i
![select_template_yaml.png](../_images/select_template_yaml.png)
Provide a name of your stack and your openstack password:
Provide a name of your stack and your 3Engines password:
![launch_stack.png](../_images/launch_stack.png)
@ -199,7 +199,7 @@ parameters:
default: <insert your ssh key name here>
image_id:
type: string
description: Image to be used. Check all available options in Horizon dashboard or, with CLI, use openstack image list command.
description: Image to be used. Check all available options in Horizon dashboard or, with CLI, use 3Engines image list command.
default: Ubuntu 18.04 LTS
private_net_id:
type: string
@ -279,12 +279,12 @@ The first step is to create a real volume (called VOL\_FAQ) and the second is to
: Property to define a bootable Cinder volume for instance.
**outputs**
: Additional information concerning deployed elements of the stack. In this case it returns a “show” attribute output. You can examine this kind of information by using openstack stack output list. Available attributes for every component [can be found here.](https://docs.openstack.org/heat/latest/template_guide/openstack.html.md).
: Additional information concerning deployed elements of the stack. In this case it returns a “show” attribute output. You can examine this kind of information by using 3Engines stack output list. Available attributes for every component [can be found here.](https://docs.3Engines.org/heat/latest/template_guide/3Engines.html.md).
Execute the template with the following command:
```
openstack stack create -t template4.yaml four
3Engines stack create -t template4.yaml four
```

22
docs/openstackcli/How-to-create-instance-snapshot-using-OpenStack-CLI-on-3Engines-Cloud.html.md → docs/openstackcli/How-to-create-instance-snapshot-using-3Engines-CLI-on-3Engines-Cloud.html.md
View File

@ -1,7 +1,7 @@
How to create instance snapshot using OpenStack CLI on 3Engines Cloud[🔗](#how-to-create-instance-snapshot-using-openstack-cli-on-brand-name "Permalink to this headline")
How to create instance snapshot using 3Engines CLI on 3Engines Cloud[🔗](#how-to-create-instance-snapshot-using-3Engines-cli-on-brand-name "Permalink to this headline")
===========================================================================================================================================================================
In this article, you will learn how to create instance snapshot on 3Engines Cloud cloud, using OpenStack CLI.
In this article, you will learn how to create instance snapshot on 3Engines Cloud cloud, using 3Engines CLI.
Instance snapshots allow you to archive the state of the virtual machine. You can, then, use them for
@ -37,18 +37,18 @@ You need a 3Engines Cloud hosting account with access to the Horizon interface:
No. 2 **Ephemeral storage vs. persistent storage**
Please see article [Ephemeral vs Persistent storage option Create New Volume on 3Engines Cloud](../datavolume/Ephemeral-vs-Persistent-storage-option-Create-New-Volume-on-3Engines-Cloud.html.md) to understand the basic difference between ephemeral and persistent types of storage in OpenStack.
Please see article [Ephemeral vs Persistent storage option Create New Volume on 3Engines Cloud](../datavolume/Ephemeral-vs-Persistent-storage-option-Create-New-Volume-on-3Engines-Cloud.html.md) to understand the basic difference between ephemeral and persistent types of storage in 3Engines.
No. 3 **Instance with ephemeral storage**
You need a virtual machine hosted on 3Engines Cloud cloud.
You can create an instance with ephemeral storage by following this article: [How to create a VM using the OpenStack CLI client on 3Engines Cloud cloud](../cloud/How-to-create-a-VM-using-the-OpenStack-CLI-client-on-3Engines-Cloud-cloud.html.md)
You can create an instance with ephemeral storage by following this article: [How to create a VM using the 3Engines CLI client on 3Engines Cloud cloud](../cloud/How-to-create-a-VM-using-the-3Engines-CLI-client-on-3Engines-Cloud-cloud.html.md)
The actual command used to create an instance from that article was
```
openstack server create \
3Engines server create \
--image Debian-custom-upload \
--flavor eo1.small \
--key-name ssh-key \
@ -73,7 +73,7 @@ When creating an instance with persistent storage, you just add one new option t
Make sure to enter the amount of storage sufficient for your needs.
You can also look at storage size available with your chosen virtual machine flavor for guidance (**openstack flavor list** command, column **Disk**)
You can also look at storage size available with your chosen virtual machine flavor for guidance (**3Engines flavor list** command, column **Disk**)
For instance, if you want your boot volume to have 16 GB, add the following:
@ -85,7 +85,7 @@ For instance, if you want your boot volume to have 16 GB, add the following:
The complete command would, then, look like this:
```
openstack server create \
3Engines server create \
--image Debian-custom-upload \
--flavor eo1.small \
--key-name ssh-key \
@ -111,12 +111,12 @@ Otherwise, an instance can have two or more volumes attached to it, however, onl
No. 5 **How to delete resources**
If you want to learn how to delete instances, snapshots, volumes and other OpenStack objects, please have a look at the following articles:
If you want to learn how to delete instances, snapshots, volumes and other 3Engines objects, please have a look at the following articles:
/networking/How-to-correctly-delete-all-the-resources-in-the-project-via-OpenStack-commandline-Clients-on-3Engines-Cloud.
/networking/How-to-correctly-delete-all-the-resources-in-the-project-via-3Engines-commandline-Clients-on-3Engines-Cloud.
[How to create or delete volume snapshot on 3Engines Cloud](../datavolume/How-to-create-or-delete-volume-snapshot-on-3Engines-Cloud.html.md).
No. 6 **OpenStack CLI client**
No. 6 **3Engines CLI client**
You need to have OpenStack CLI client installed. One of the following articles should help you:
You need to have 3Engines CLI client installed. One of the following articles should help you:

62
docs/openstackcli/How-to-install-OpenStackClient-GitBash-or-Cygwin-for-Windows-on-3Engines-Cloud.html.md → docs/openstackcli/How-to-install-3EnginesClient-GitBash-or-Cygwin-for-Windows-on-3Engines-Cloud.html.md
View File

@ -1,9 +1,9 @@
How to install OpenStackClient GitBash for Windows on 3Engines Cloud[🔗](#how-to-install-openstackclient-gitbash-for-windows-on-brand-name "Permalink to this headline")
How to install 3EnginesClient GitBash for Windows on 3Engines Cloud[🔗](#how-to-install-3Enginesclient-gitbash-for-windows-on-brand-name "Permalink to this headline")
=========================================================================================================================================================================
In this tutorial, you start with a standard Windows installation, then install the OpenStack CLI client and end up connecting to your project on 3Engines Cloud cloud.
In this tutorial, you start with a standard Windows installation, then install the 3Engines CLI client and end up connecting to your project on 3Engines Cloud cloud.
> For another way of installing OpenStack CLI on Windows, see article [How to install OpenStackClient on Windows using Windows Subsystem for Linux on 3Engines Cloud OpenStack Hosting](How-to-install-OpenStackClient-on-Windows-using-Windows-Subsystem-for-Linux-on-3Engines-Cloud-OpenStack-Hosting.html.md). However:
> For another way of installing 3Engines CLI on Windows, see article [How to install 3EnginesClient on Windows using Windows Subsystem for Linux on 3Engines Cloud 3Engines Hosting](How-to-install-3EnginesClient-on-Windows-using-Windows-Subsystem-for-Linux-on-3Engines-Cloud-3Engines-Hosting.html.md). However:
* using Git Bash is simpler than using Windows Subsystem for Linux and is
* providing a more straightforward access to your local file system.
@ -12,9 +12,9 @@ What We Are Going To Cover[🔗](#what-we-are-going-to-cover "Permalink to this
---------------------------------------------------------------------------------------
> * Installing the required software (Python 3, PIP, Git for Windows and the appropriate compilers)
> * Creating an isolated Python environment for installing the OpenStack CLI client
> * Installing the OpenStack CLI client
> * Authenticating the OpenStack CLI client to the cloud
> * Creating an isolated Python environment for installing the 3Engines CLI client
> * Installing the 3Engines CLI client
> * Authenticating the 3Engines CLI client to the cloud
> * Executing a simple command to test whether the process was successful
Prerequisites[🔗](#prerequisites "Permalink to this headline")
@ -38,9 +38,9 @@ You will need basic knowledge of Linux command line.
No. 4 **RC file downloaded**
You need to download the RC file from your Horizon dashboard. To do that, follow section **How to download the RC file** of the following article: /gettingstarted/How-to-activate-OpenStack-CLI-access-to-3Engines-Cloud-cloud-using-one-or-two-factor-authentication.
You need to download the RC file from your Horizon dashboard. To do that, follow section **How to download the RC file** of the following article: /gettingstarted/How-to-activate-3Engines-CLI-access-to-3Engines-Cloud-cloud-using-one-or-two-factor-authentication.
This file must be present on the machine on which you intend to use the OpenStack CLI client.
This file must be present on the machine on which you intend to use the 3Engines CLI client.
Step 1: Download and Install Python[🔗](#step-1-download-and-install-python "Permalink to this headline")
--------------------------------------------------------------------------------------------------------
@ -143,7 +143,7 @@ pip install -U requests[security]
Step 4: Install Microsoft C++ Build Tools[🔗](#step-4-install-microsoft-c-build-tools "Permalink to this headline")
------------------------------------------------------------------------------------------------------------------
Microsoft C++ Build Tools are required to install the OpenStack CLI client using **pip** on Windows.
Microsoft C++ Build Tools are required to install the 3Engines CLI client using **pip** on Windows.
Enter the following website: <https://visualstudio.microsoft.com/visual-cpp-build-tools/>
@ -161,7 +161,7 @@ The installation process might take a long time.
Reboot your computer if the installer prompts you to do so.
Step 5: Install virtualenv and the OpenStack CLI client[🔗](#step-5-install-virtualenv-and-the-openstack-cli-client "Permalink to this headline")
Step 5: Install virtualenv and the 3Engines CLI client[🔗](#step-5-install-virtualenv-and-the-3Engines-cli-client "Permalink to this headline")
------------------------------------------------------------------------------------------------------------------------------------------------
**virtualenv** allows you to perform Python operations in an isolated environment. In order to install it, open Git Bash if you previously closed it or rebooted your computer, and execute the following command:
@ -171,32 +171,32 @@ pip install virtualenv
```
With **cd** command enter the directory in which you want to store the environment in which the OpenStack CLI client will be running. You will need it later on, so make it easily accessible, for example:
With **cd** command enter the directory in which you want to store the environment in which the 3Engines CLI client will be running. You will need it later on, so make it easily accessible, for example:
```
cd C:/Users/Administrator
```
Execute the following command to create the virtual environment **openstack\_cli** which will be used for the OpenStack CLI client:
Execute the following command to create the virtual environment **3Engines\_cli** which will be used for the 3Engines CLI client:
```
virtualenv openstack_cli
virtualenv 3Engines_cli
```
Note
You must supply the name of the environment (here, **openstack\_cli**) but what it will be is completely up to you.
You must supply the name of the environment (here, **3Engines\_cli**) but what it will be is completely up to you.
A directory called **openstack\_cli** should appear in the current folder. It will contain files needed for your isolated environment. In order to enter that environment, run **source** command on the **activate** file which is in the **Scripts** folder found in the folder with your virtual environment:
A directory called **3Engines\_cli** should appear in the current folder. It will contain files needed for your isolated environment. In order to enter that environment, run **source** command on the **activate** file which is in the **Scripts** folder found in the folder with your virtual environment:
```
source openstack_cli/Scripts/activate
source 3Engines_cli/Scripts/activate
```
From now on, the name of your isolated environment - **openstack\_cli** - will be in brackets before each command prompt, indicating that you are inside it.
From now on, the name of your isolated environment - **3Engines\_cli** - will be in brackets before each command prompt, indicating that you are inside it.
![git-bash12_creodias.png](../_images/git-bash12_creodias.png)
@ -216,7 +216,7 @@ Git Bash emulates UNIX-based systems so while you are in it, use forward slashes
Step 6: Download and prepare jq[🔗](#step-6-download-and-prepare-jq "Permalink to this headline")
------------------------------------------------------------------------------------------------
To authenticate the OpenStack CLI client in the next step, a program called **jq** will be needed. It is a JSON preprocessor, running from command line. To install, navigate to <https://jqlang.github.io/jq/download/> using your Internet browser.
To authenticate the 3Engines CLI client in the next step, a program called **jq** will be needed. It is a JSON preprocessor, running from command line. To install, navigate to <https://jqlang.github.io/jq/download/> using your Internet browser.
Download the latest 64-bit executable version of **jq** for Windows.
@ -231,17 +231,17 @@ mv jq.exe /usr/bin
This should allow you to use **jq** with the RC file easily.
Step 7: Install and configure the OpenStack CLI client[🔗](#step-7-install-and-configure-the-openstack-cli-client "Permalink to this headline")
Step 7: Install and configure the 3Engines CLI client[🔗](#step-7-install-and-configure-the-3Engines-cli-client "Permalink to this headline")
----------------------------------------------------------------------------------------------------------------------------------------------
Without leaving Git Bash, while still inside the **openstack\_cli** virtual environment, execute the following command:
Without leaving Git Bash, while still inside the **3Engines\_cli** virtual environment, execute the following command:
```
pip install python-openstackclient
pip install python-3Enginesclient
```
Wait until the process is completed. As the result, you will be able to run **openstack** command on terminal prompt. It, however, won’t have access to the 3Engines Cloud cloud, so the next step is to authenticate to the cloud.
Wait until the process is completed. As the result, you will be able to run **3Engines** command on terminal prompt. It, however, won’t have access to the 3Engines Cloud cloud, so the next step is to authenticate to the cloud.
Navigate to the location of the RC file which you downloaded while following Prerequisite No. 4 and execute the **source** command on it. It could look like this (if the name of your RC file is **main-openrc.sh**):
@ -260,10 +260,10 @@ Here is what the two step process of authentication looks like for an RC file ca
On the screenshot above, the username and project name were hidden for privacy reasons.
In order to test whether the OpenStack CLI client works, list virtual machines you currently operate. The command is:
In order to test whether the 3Engines CLI client works, list virtual machines you currently operate. The command is:
```
openstack server list
3Engines server list
```
@ -272,11 +272,11 @@ The output should contain a table containing virtual machines from your project.
Reentering the Isolated Python Environment[🔗](#reentering-the-isolated-python-environment "Permalink to this headline")
-----------------------------------------------------------------------------------------------------------------------
To run the OpenStack CLI client again, say, after you might have closed the Git Bash window, or have had shut down or restarted Windows, you would have to repeat the same commands you entered above (replace **C:/Users/Administrator** with the path containing your **openstack\_cli** folder).
To run the 3Engines CLI client again, say, after you might have closed the Git Bash window, or have had shut down or restarted Windows, you would have to repeat the same commands you entered above (replace **C:/Users/Administrator** with the path containing your **3Engines\_cli** folder).
```
cd C:/Users/Administrator
source openstack_cli/Scripts/activate
source 3Engines_cli/Scripts/activate
```
@ -287,18 +287,18 @@ You can also create a batch file to automate reentering the Python environment.
What To Do Next[🔗](#what-to-do-next "Permalink to this headline")
-----------------------------------------------------------------
The article [How To Install OpenStack and Magnum Clients for Command Line Interface to 3Engines Cloud Horizon](../kubernetes/How-To-Install-OpenStack-and-Magnum-Clients-for-Command-Line-Interface-to-3Engines-Cloud-Horizon.html.md) will give you another procedure to install CLI and connect it to the cloud. It also contains several examples of using the CLI commands.
The article [How To Install 3Engines and Magnum Clients for Command Line Interface to 3Engines Cloud Horizon](../kubernetes/How-To-Install-3Engines-and-Magnum-Clients-for-Command-Line-Interface-to-3Engines-Cloud-Horizon.html.md) will give you another procedure to install CLI and connect it to the cloud. It also contains several examples of using the CLI commands.
Other articles of interest:
[How to Create and Configure New Openstack Project Through Horizon on 3Engines Cloud Cloud](How-To-Create-and-Configure-New-Project-on-3Engines-Cloud-Cloud.html.md)
[How to Create and Configure New 3Engines Project Through Horizon on 3Engines Cloud Cloud](How-To-Create-and-Configure-New-Project-on-3Engines-Cloud-Cloud.html.md)
[How to create a set of VMs using OpenStack Heat Orchestration on 3Engines Cloud](How-to-create-a-set-of-VMs-using-OpenStack-Heat-Orchestration-on-3Engines-Cloud.html.md)
[How to create a set of VMs using 3Engines Heat Orchestration on 3Engines Cloud](How-to-create-a-set-of-VMs-using-3Engines-Heat-Orchestration-on-3Engines-Cloud.html.md)
Using CLI interface for Kubernetes clusters:
[How To Use Command Line Interface for Kubernetes Clusters On 3Engines Cloud OpenStack Magnum](../kubernetes/How-To-Use-Command-Line-Interface-for-Kubernetes-Clusters-On-3Engines-Cloud-OpenStack-Magnum.html.md)
[How To Use Command Line Interface for Kubernetes Clusters On 3Engines Cloud 3Engines Magnum](../kubernetes/How-To-Use-Command-Line-Interface-for-Kubernetes-Clusters-On-3Engines-Cloud-3Engines-Magnum.html.md)
Also see
[How to activate OpenStack CLI access to 3Engines Cloud cloud using one- or two-factor authentication](../accountmanagement/How-to-activate-OpenStack-CLI-access-to-3Engines-Cloud-cloud-using-one-or-two-factor-authentication.html.md)
[How to activate 3Engines CLI access to 3Engines Cloud cloud using one- or two-factor authentication](../accountmanagement/How-to-activate-3Engines-CLI-access-to-3Engines-Cloud-cloud-using-one-or-two-factor-authentication.html.md)

8
docs/openstackcli/How-to-install-OpenStackClient-for-Linux-on-3Engines-Cloud.html.md → docs/openstackcli/How-to-install-3EnginesClient-for-Linux-on-3Engines-Cloud.html.md
View File

@ -1,7 +1,7 @@
How to install OpenStackClient for Linux on 3Engines Cloud[🔗](#how-to-install-openstackclient-for-linux-on-brand-name "Permalink to this headline")
How to install 3EnginesClient for Linux on 3Engines Cloud[🔗](#how-to-install-3Enginesclient-for-linux-on-brand-name "Permalink to this headline")
=====================================================================================================================================================
The OpenStack CLI client allows you to manage OpenStack environments using the command line interface. Its functions include:
The 3Engines CLI client allows you to manage 3Engines environments using the command line interface. Its functions include:
> * Creating, starting, shutting down, shelving, deleting, rebooting virtual machines
> * Assigning a floating IP to your virtual machine
@ -11,9 +11,9 @@ You can also automate these operations using scripts.
This article covers two methods of installing this piece of software on Ubuntu. The first method should be more convenient and sufficient for most needs. The second method is for advanced use cases, such as:
> * keeping multiple versions of the OpenStack CLI client ready to use on the same computer or
> * keeping multiple versions of the 3Engines CLI client ready to use on the same computer or
> * needing more advanced features than what Ubuntu packages provide and
> * having to use the OpenStack CLI client on a Linux distribution which does not support the installation method described in the first method.
> * having to use the 3Engines CLI client on a Linux distribution which does not support the installation method described in the first method.
Prerequisites[🔗](#prerequisites "Permalink to this headline")
-------------------------------------------------------------

52
docs/openstackcli/How-to-install-OpenStackClient-on-Windows-using-Windows-Subsystem-for-Linux-on-3Engines-Cloud-OpenStack-Hosting.html.md → docs/openstackcli/How-to-install-3EnginesClient-on-Windows-using-Windows-Subsystem-for-Linux-on-3Engines-Cloud-3Engines-Hosting.html.md
View File

@ -1,7 +1,7 @@
How to install OpenStackClient on Windows using Windows Subsystem for Linux on 3Engines Cloud OpenStack Hosting[🔗](#how-to-install-openstackclient-on-windows-using-windows-subsystem-for-linux-on-brand-name-openstack-hosting "Permalink to this headline")
How to install 3EnginesClient on Windows using Windows Subsystem for Linux on 3Engines Cloud 3Engines Hosting[🔗](#how-to-install-3Enginesclient-on-windows-using-windows-subsystem-for-linux-on-brand-name-3Engines-hosting "Permalink to this headline")
===============================================================================================================================================================================================================================================================
In this tutorial, you will control your OpenStack environment in a deeper and more precise way using the CLI (Command Line Interface). Of course, you can use the Horizon GUI (Graphical User Interface) running in your browser, but the CLI includes additional features like the ability to use scripts for more automated management of your environment.
In this tutorial, you will control your 3Engines environment in a deeper and more precise way using the CLI (Command Line Interface). Of course, you can use the Horizon GUI (Graphical User Interface) running in your browser, but the CLI includes additional features like the ability to use scripts for more automated management of your environment.
The instructions for installing Windows Subsystem for Linux are based on the official Windows documentation found at <https://learn.microsoft.com/en-us/windows/wsl/>.
@ -9,7 +9,7 @@ What We Are Going To Cover[🔗](#what-we-are-going-to-cover "Permalink to this
---------------------------------------------------------------------------------------
> * Installing Windows Subsystem for Linux on Microsoft Windows
> * Installing the OpenStack CLI client and authenticating
> * Installing the 3Engines CLI client and authenticating
Prerequisites[🔗](#prerequisites "Permalink to this headline")
-------------------------------------------------------------
@ -28,7 +28,7 @@ Your computer must be running Microsoft Windows. This article is written for Win
No. 3 **Optional – software for 2FA authentication**
Your account at 3Engines Cloud cloud may have two-factor authentication enabled. It means that apart from the usual username and password combination, you also need software to generate the TOTP – the six-digit code for the additional, second step of authentication. This article will provide additional technical details: [How to activate OpenStack CLI access to 3Engines Cloud cloud using one- or two-factor authentication](../accountmanagement/How-to-activate-OpenStack-CLI-access-to-3Engines-Cloud-cloud-using-one-or-two-factor-authentication.html.md).
Your account at 3Engines Cloud cloud may have two-factor authentication enabled. It means that apart from the usual username and password combination, you also need software to generate the TOTP – the six-digit code for the additional, second step of authentication. This article will provide additional technical details: [How to activate 3Engines CLI access to 3Engines Cloud cloud using one- or two-factor authentication](../accountmanagement/How-to-activate-3Engines-CLI-access-to-3Engines-Cloud-cloud-using-one-or-two-factor-authentication.html.md).
Step 1: Check the version of Windows[🔗](#step-1-check-the-version-of-windows "Permalink to this headline")
----------------------------------------------------------------------------------------------------------
@ -158,10 +158,10 @@ Wait for a short time. Eventually your Linux environment will be ready:
![wsl19_creodias.png](../_images/wsl19_creodias.png)
Step 3: Install OpenStack CLI in an isolated Python environment[🔗](#step-3-install-openstack-cli-in-an-isolated-python-environment "Permalink to this headline")
Step 3: Install 3Engines CLI in an isolated Python environment[🔗](#step-3-install-3Engines-cli-in-an-isolated-python-environment "Permalink to this headline")
----------------------------------------------------------------------------------------------------------------------------------------------------------------
Now that you have installed Windows Subsystem on Linux running Ubuntu on your Windows computer, it is time to install OpenStack CLI.
Now that you have installed Windows Subsystem on Linux running Ubuntu on your Windows computer, it is time to install 3Engines CLI.
Update the software running on your Ubuntu:
@ -177,17 +177,17 @@ sudo apt install python3-venv
```
Create a virtual environment in which you will have OpenStack CLI installed:
Create a virtual environment in which you will have 3Engines CLI installed:
```
python3 -m venv openstack_cli
python3 -m venv 3Engines_cli
```
Enter your new virtual environment:
```
source openstack_cli/bin/activate
source 3Engines_cli/bin/activate
```
@ -198,17 +198,17 @@ pip install --upgrade pip
```
Install the **python-openstackclient** package:
Install the **python-3Enginesclient** package:
```
pip install python-openstackclient
pip install python-3Enginesclient
```
Verify that the OpenStack CLI works by viewing its help:
Verify that the 3Engines CLI works by viewing its help:
```
openstack --help
3Engines --help
```
@ -216,7 +216,7 @@ If the command shows its output using a pager, you should be able to use the arr
If everything seems to work, time to move to the next step - authentication to your user account on 3Engines Cloud.
Step 4: Download your OpenStack RC File[🔗](#step-4-download-your-openstack-rc-file "Permalink to this headline")
Step 4: Download your 3Engines RC File[🔗](#step-4-download-your-3Engines-rc-file "Permalink to this headline")
----------------------------------------------------------------------------------------------------------------
Login to 3Engines Cloud hosting account with Horizon interface <https://horizon.3Engines.com>.
@ -225,7 +225,7 @@ Click on your username in the upper right corner. You will see the following men
![wsl20_creodias.png](../_images/wsl20_creodias.png)
If your account has two factor authentication enabled, click the option **OpenStack RC File (2FA)**. If, however, it does not have it enabled, use the **OpenStack RC File** option.
If your account has two factor authentication enabled, click the option **3Engines RC File (2FA)**. If, however, it does not have it enabled, use the **3Engines RC File** option.
The RC file will be downloaded. Memorize or write somewhere down the name of that file. Move this file to the root location of your **C:** drive.
@ -264,19 +264,19 @@ After having entered your code, press Enter.
Now you can test whether you have successfully authenticated by listing your VMs:
```
openstack server list
3Engines server list
```
How to run this environment later?[🔗](#how-to-run-this-environment-later "Permalink to this headline")
------------------------------------------------------------------------------------------------------
If you close the window with Ubuntu and reopen it, you will see that you are no longer in the **openstack\_cli** environment you created and thus no longer have access to OpenStack. You will need to reenter the **openstack\_cli** environment and reauthenticate.
If you close the window with Ubuntu and reopen it, you will see that you are no longer in the **3Engines\_cli** environment you created and thus no longer have access to 3Engines. You will need to reenter the **3Engines\_cli** environment and reauthenticate.
After reopening the Ubuntu Window, execute the **source** command on the file used for entering you **openstack\_cli** environment, just like previously:
After reopening the Ubuntu Window, execute the **source** command on the file used for entering you **3Engines\_cli** environment, just like previously:
```
source openstack_cli/bin/activate
source 3Engines_cli/bin/activate
```
@ -287,19 +287,19 @@ source main-openrc.sh
```
Type your password and press Enter. You should now be able execute the OpenStack CLI commands as usual.
Type your password and press Enter. You should now be able execute the 3Engines CLI commands as usual.
What To Do Next[🔗](#what-to-do-next "Permalink to this headline")
-----------------------------------------------------------------
After installing the OpenStack CLI client and activating your new RC file, you can use other articles to perform operations on 3Engines Cloud cloud:
After installing the 3Engines CLI client and activating your new RC file, you can use other articles to perform operations on 3Engines Cloud cloud:
[How to create a set of VMs using OpenStack Heat Orchestration on 3Engines Cloud](How-to-create-a-set-of-VMs-using-OpenStack-Heat-Orchestration-on-3Engines-Cloud.html.md)
[How to create a set of VMs using 3Engines Heat Orchestration on 3Engines Cloud](How-to-create-a-set-of-VMs-using-3Engines-Heat-Orchestration-on-3Engines-Cloud.html.md)
[Generating and authorizing Terraform using Keycloak user on 3Engines Cloud](../openstackdev/Generating-and-authorizing-Terraform-using-Keycloak-user-on-3Engines-Cloud.html.md)
[Generating and authorizing Terraform using Keycloak user on 3Engines Cloud](../3Enginesdev/Generating-and-authorizing-Terraform-using-Keycloak-user-on-3Engines-Cloud.html.md)
[How to upload your custom image using OpenStack CLI on 3Engines Cloud](../cloud/How-to-upload-your-custom-image-using-OpenStack-CLI-on-3Engines-Cloud.html.md)
[How to upload your custom image using 3Engines CLI on 3Engines Cloud](../cloud/How-to-upload-your-custom-image-using-3Engines-CLI-on-3Engines-Cloud.html.md)
[How to create a VM using the OpenStack CLI client on 3Engines Cloud cloud](../cloud/How-to-create-a-VM-using-the-OpenStack-CLI-client-on-3Engines-Cloud-cloud.html.md)
[How to create a VM using the 3Engines CLI client on 3Engines Cloud cloud](../cloud/How-to-create-a-VM-using-the-3Engines-CLI-client-on-3Engines-Cloud-cloud.html.md)
[How To Use Command Line Interface for Kubernetes Clusters On 3Engines Cloud OpenStack Magnum](../kubernetes/How-To-Use-Command-Line-Interface-for-Kubernetes-Clusters-On-3Engines-Cloud-OpenStack-Magnum.html.md)
[How To Use Command Line Interface for Kubernetes Clusters On 3Engines Cloud 3Engines Magnum](../kubernetes/How-To-Use-Command-Line-Interface-for-Kubernetes-Clusters-On-3Engines-Cloud-3Engines-Magnum.html.md)

8
docs/openstackcli/How-to-move-data-volume-between-two-VMs-using-OpenStack-CLI-on-3Engines-Cloud.html.md → docs/openstackcli/How-to-move-data-volume-between-two-VMs-using-3Engines-CLI-on-3Engines-Cloud.html.md
View File

@ -1,9 +1,9 @@
How to move data volume between VMs using OpenStack CLI on 3Engines Cloud[🔗](#how-to-move-data-volume-between-vms-using-openstack-cli-on-brand-name "Permalink to this headline")
How to move data volume between VMs using 3Engines CLI on 3Engines Cloud[🔗](#how-to-move-data-volume-between-vms-using-3Engines-cli-on-brand-name "Permalink to this headline")
===================================================================================================================================================================================
Volumes are used to store data and those data can be accessed from a virtual machine to which the volume is attached. To access data stored on a volume from another virtual machine, you need to disconnect that volume from virtual machine to which it is currently connected, and connect it to another instance.
This article uses OpenStack CLI client to transfer volumes between virtual machines which are in the same project.
This article uses 3Engines CLI client to transfer volumes between virtual machines which are in the same project.
Prerequisites[🔗](#prerequisites "Permalink to this headline")
-------------------------------------------------------------
@ -12,6 +12,6 @@ No. 1 **Hosting**
You need a 3Engines Cloud hosting account with Horizon interface <https://horizon.3Engines.com>.
No. 2 **OpenStack CLI client**
No. 2 **3Engines CLI client**
To be able to use the OpenStack CLI client, you need to have it installed. One of these articles should help:
To be able to use the 3Engines CLI client, you need to have it installed. One of these articles should help:

40
docs/openstackcli/How-to-share-private-container-from-object-storage-to-another-user-on-3Engines-Cloud.html.md
View File

@ -16,21 +16,21 @@ No. 1 **Hosting**
You need a 3Engines Cloud hosting account with Horizon interface <https://horizon.3Engines.com>.
No. 2 **OpenStack client installed and connected to the cloud**
No. 2 **3Engines client installed and connected to the cloud**
The following article will help you install Python and OpenStack client called **openstack** and will also help you connect to the cloud [How to install OpenStackClient for Linux on 3Engines Cloud](How-to-install-OpenStackClient-for-Linux-on-3Engines-Cloud.html.md)).
The following article will help you install Python and 3Engines client called **3Engines** and will also help you connect to the cloud [How to install 3EnginesClient for Linux on 3Engines Cloud](How-to-install-3EnginesClient-for-Linux-on-3Engines-Cloud.html.md)).
No. 3 **Knowledge of downloading and working with RC files**
To be able to share private containers, you will have to manipulate RC files from the cloud. The following article will provide technical details:
[How to activate OpenStack CLI access to 3Engines Cloud cloud using one- or two-factor authentication](../accountmanagement/How-to-activate-OpenStack-CLI-access-to-3Engines-Cloud-cloud-using-one-or-two-factor-authentication.html.md)
[How to activate 3Engines CLI access to 3Engines Cloud cloud using one- or two-factor authentication](../accountmanagement/How-to-activate-3Engines-CLI-access-to-3Engines-Cloud-cloud-using-one-or-two-factor-authentication.html.md)
No. 4. **Using OpenStack Swift module**
No. 4. **Using 3Engines Swift module**
The OpenStack Object Store module, known as *Swift*, allows you to store and retrieve data with a simple API. It’s built for scale and is optimized for durability, availability, and concurrency across the entire data set. Swift is ideal for storing unstructured data that can grow without bound.
The 3Engines Object Store module, known as *Swift*, allows you to store and retrieve data with a simple API. It’s built for scale and is optimized for durability, availability, and concurrency across the entire data set. Swift is ideal for storing unstructured data that can grow without bound.
See [How to access object storage using OpenStack CLI on 3Engines Cloud](How-to-access-object-storage-using-OpenStack-CLI-on-3Engines-Cloud.html.md)
See [How to access object storage using 3Engines CLI on 3Engines Cloud](How-to-access-object-storage-using-3Engines-CLI-on-3Engines-Cloud.html.md)
Setting up the test example[🔗](#setting-up-the-test-example "Permalink to this headline")
-----------------------------------------------------------------------------------------
@ -87,7 +87,7 @@ Then, they should choose the main project:
![owner_main.png](../_images/owner_main.png)
After that, they should download the “OpenStack RC File” for the user “owner” and the project “main”:
After that, they should download the “3Engines RC File” for the user “owner” and the project “main”:
![owner_rc.png](../_images/owner_rc.png)
@ -106,7 +106,7 @@ $ cat main-openrc.sh
```
#!/usr/bin/env bash
# To use an OpenStack cloud you need to authenticate against the Identity
# To use an 3Engines cloud you need to authenticate against the Identity
# service named keystone, which returns a **Token** and **Service Catalog**.
# The catalog contains the endpoints for all services the user/tenant has
# access to - such as Compute, Image Service, Identity, Object Storage, Block
@ -114,7 +114,7 @@ $ cat main-openrc.sh
# cinder, and neutron).
#
# *NOTE*: Using the 3 *Identity API* does not necessarily mean any other
# OpenStack API is version 3. For example, your cloud provider may implement
# 3Engines API is version 3. For example, your cloud provider may implement
# Image API v1.1, Block Storage API v2, and Compute API v2.0. OS_AUTH_URL is
# only for the Identity API served through keystone.
unset OS_TENANT_ID
@ -130,7 +130,7 @@ export OS_PROJECT_DOMAIN_ID="119f4676f307434eaf28daab5ba3cc92"
if [ -z "$OS_REGION_NAME" ]; then unset OS_REGION_NAME; fi
if [ -z "$OS_USER_DOMAIN_NAME" ]; then unset OS_USER_DOMAIN_NAME; fi
if [ -z "$OS_PROJECT_DOMAIN_ID" ]; then unset OS_PROJECT_DOMAIN_ID; fi
echo "Please enter your OpenStack Password for project $OS_PROJECT_NAME as user $OS_USERNAME: "
echo "Please enter your 3Engines Password for project $OS_PROJECT_NAME as user $OS_USERNAME: "
read -sr OS_PASSWORD_INPUT
export OS_PASSWORD=$OS_PASSWORD_INPUT
export OS_AUTH_TYPE=password
@ -146,13 +146,13 @@ Copy the file **main-openrc.sh** to your CLI directory.
The user called “user\_1” should do the same procedure:
1. login to their “project\_1”
2. download the “OpenStack RC File” for user “user\_1” and project “project\_1”
2. download the “3Engines RC File” for user “user\_1” and project “project\_1”
project\_1-openrc.sh
```
#!/usr/bin/env bash
# To use an OpenStack cloud you need to authenticate against the Identity
# To use an 3Engines cloud you need to authenticate against the Identity
# service named keystone, which returns a **Token** and **Service Catalog**.
# The catalog contains the endpoints for all services the user/tenant has
# access to - such as Compute, Image Service, Identity, Object Storage, Block
@ -160,7 +160,7 @@ project\_1-openrc.sh
# cinder, and neutron).
#
# *NOTE*: Using the 3 *Identity API* does not necessarily mean any other
# OpenStack API is version 3. For example, your cloud provider may implement
# 3Engines API is version 3. For example, your cloud provider may implement
# Image API v1.1, Block Storage API v2, and Compute API v2.0. OS_AUTH_URL is
# only for the Identity API served through keystone.
unset OS_TENANT_ID
@ -176,7 +176,7 @@ export OS_PROJECT_DOMAIN_ID="119f4676f307434eaf28daab5ba3cc92"
if [ -z "$OS_REGION_NAME" ]; then unset OS_REGION_NAME; fi
if [ -z "$OS_USER_DOMAIN_NAME" ]; then unset OS_USER_DOMAIN_NAME; fi
if [ -z "$OS_PROJECT_DOMAIN_ID" ]; then unset OS_PROJECT_DOMAIN_ID; fi
echo "Please enter your OpenStack Password for project $OS_PROJECT_NAME as user $OS_USERNAME: "
echo "Please enter your 3Engines Password for project $OS_PROJECT_NAME as user $OS_USERNAME: "
read -sr OS_PASSWORD_INPUT
export OS_PASSWORD=$OS_PASSWORD_INPUT
export OS_AUTH_TYPE=password
@ -195,7 +195,7 @@ terminal of user “owner”
```
$ source main-openrc.sh
Please enter your OpenStack Password for project main as user owner: <here enter the password for owner>
Please enter your 3Engines Password for project main as user owner: <here enter the password for owner>
(owner) $ swift list
c-main-a
@ -211,7 +211,7 @@ terminal of user “user\_1”:
```
$ source project_1-openrc.sh
Please enter your OpenStack Password for project project_1 as user user_1:
Please enter your 3Engines Password for project project_1 as user user_1:
<here enter the password for user_1>
(user_1) $ swift list
@ -227,7 +227,7 @@ terminal of user “user\_2”:
```
$ source project_2-openrc.sh
Please enter your OpenStack Password for project project_2 as user user_2: <here enter the password for user_2>
Please enter your 3Engines Password for project project_2 as user user_2: <here enter the password for user_2>
(user_2) $ swift list
c-project_2-a
@ -273,7 +273,7 @@ test-main-d.txt
Check the id of user\_1:
```
(user_1) $ openstack user show --format json "${OS_USERNAME}" | jq -r .id
(user_1) $ 3Engines user show --format json "${OS_USERNAME}" | jq -r .id
3de5f40b4e6d433792ac387896729ec8
```
@ -281,7 +281,7 @@ Check the id of user\_1:
Check the id of user\_2:
```
(user_2) $ openstack user show --format json "${OS_USERNAME}" | jq -r .id
(user_2) $ 3Engines user show --format json "${OS_USERNAME}" | jq -r .id
fb4ec0de674d4c5ba608ee75cc6da918
```
@ -306,7 +306,7 @@ X-Container-Bytes-Used-Actual: 8192
X-Storage-Class: STANDARD
Last-Modified: Tue, 14 Jun 2022 13:41:32 GMT
X-Trans-Id: tx000000000000003964e44-0062b17ebb-17404e6b-default
X-Openstack-Request-Id: tx000000000000003964e44-0062b17ebb-17404e6b-default
X-3Engines-Request-Id: tx000000000000003964e44-0062b17ebb-17404e6b-default
Accept-Ranges: bytes
Content-Type: text/plain; charset=utf-8

8
docs/openstackcli/How-to-start-a-VM-from-instance-snapshot-using-OpenStack-CLI-on-3Engines-Cloud.html.md → docs/openstackcli/How-to-start-a-VM-from-instance-snapshot-using-3Engines-CLI-on-3Engines-Cloud.html.md
View File

@ -1,7 +1,7 @@
How to start a VM from instance snapshot using OpenStack CLI on 3Engines Cloud[🔗](#how-to-start-a-vm-from-instance-snapshot-using-openstack-cli-on-brand-name "Permalink to this headline")
How to start a VM from instance snapshot using 3Engines CLI on 3Engines Cloud[🔗](#how-to-start-a-vm-from-instance-snapshot-using-3Engines-cli-on-brand-name "Permalink to this headline")
=============================================================================================================================================================================================
In this article, you will learn how to create a virtual machine from an instance snapshot using OpenStack CLI client.
In this article, you will learn how to create a virtual machine from an instance snapshot using 3Engines CLI client.
Prerequisites[🔗](#prerequisites "Permalink to this headline")
-------------------------------------------------------------
@ -10,6 +10,6 @@ No. 1 **Account**
You need a 3Engines Cloud hosting account with access to the Horizon interface: <https://horizon.3Engines.com>.
No. 2 **OpenStack CLI client**
No. 2 **3Engines CLI client**
You need to have OpenStack CLI client installed. One of the following articles should help you:
You need to have 3Engines CLI client installed. One of the following articles should help you:

10
docs/openstackcli/How-to-transfer-volumes-between-domains-and-projects-using-OpenStack-CLI-client-on-3Engines-Cloud.html.md → docs/openstackcli/How-to-transfer-volumes-between-domains-and-projects-using-3Engines-CLI-client-on-3Engines-Cloud.html.md
View File

@ -1,11 +1,11 @@
How to transfer volumes between domains and projects using OpenStack CLI client on 3Engines Cloud[🔗](#how-to-transfer-volumes-between-domains-and-projects-using-openstack-cli-client-on-brand-name "Permalink to this headline")
How to transfer volumes between domains and projects using 3Engines CLI client on 3Engines Cloud[🔗](#how-to-transfer-volumes-between-domains-and-projects-using-3Engines-cli-client-on-brand-name "Permalink to this headline")
===================================================================================================================================================================================================================================
Volumes in OpenStack can be used to store data. They are visible to virtual machines like drives.
Volumes in 3Engines can be used to store data. They are visible to virtual machines like drives.
Such a volume is usually available to just the project in which it was created. Transferring data stored on it between projects might take a long time, especially if such a volume contains lots of data, like, say, hundreds or thousands of gigabytes (or even more).
This article covers changing the assignment of a volume to a project. This allows you to move a volume directly from one project (which we will call *source* project) to another (which we will call *destination* project) using the OpenStack CLI in a way that does **not** require you to physically transfer the data.
This article covers changing the assignment of a volume to a project. This allows you to move a volume directly from one project (which we will call *source* project) to another (which we will call *destination* project) using the 3Engines CLI in a way that does **not** require you to physically transfer the data.
The *source* project and *destination* project must both be on the same cloud (for example WAW3-2). They can (but don’t have to) belong to different users from different domains and organizations.
@ -23,6 +23,6 @@ No. 1 **Account**
You need a 3Engines Cloud hosting account with access to the Horizon interface: <https://horizon.3Engines.com>
No. 2 **OpenStack CLI Client**
No. 2 **3Engines CLI Client**
To use the OpenStack CLI client, you need to have it installed. See one of these articles to learn how to do it:
To use the 3Engines CLI client, you need to have it installed. See one of these articles to learn how to do it:

32
docs/openstackcli/Resizing-a-virtual-machine-using-OpenStack-CLI-on-3Engines-Cloud.html.md → docs/openstackcli/Resizing-a-virtual-machine-using-3Engines-CLI-on-3Engines-Cloud.html.md
View File

@ -1,10 +1,10 @@
Resizing a virtual machine using OpenStack CLI on 3Engines Cloud[🔗](#resizing-a-virtual-machine-using-openstack-cli-on-brand-name "Permalink to this headline")
Resizing a virtual machine using 3Engines CLI on 3Engines Cloud[🔗](#resizing-a-virtual-machine-using-3Engines-cli-on-brand-name "Permalink to this headline")
=================================================================================================================================================================
Introduction[🔗](#introduction "Permalink to this headline")
-----------------------------------------------------------
When creating a new virtual machine under OpenStack, one of the options you choose is the *flavor*. A flavor is a predefined combination of CPU, memory and disk size and there usually is a number of such flavors for you to choose from.
When creating a new virtual machine under 3Engines, one of the options you choose is the *flavor*. A flavor is a predefined combination of CPU, memory and disk size and there usually is a number of such flavors for you to choose from.
After the instance is spawned, it is possible to change one flavor for another, and that process is called *resizing*. You might want to resize an already existing VM in order to:
@ -14,7 +14,7 @@ After the instance is spawned, it is possible to change one flavor for another,
> * seamlessly transition from testing to production environment,
> * change application workload byt scaling the VM up or down.
In this article, we are going to resize VMs using CLI commands in OpenStack.
In this article, we are going to resize VMs using CLI commands in 3Engines.
Prerequisites[🔗](#prerequisites "Permalink to this headline")
-------------------------------------------------------------
@ -25,7 +25,7 @@ You need a 3Engines Cloud hosting account with access to the Horizon interface:
If you are a normal user of 3Engines Cloud hosting, you will have all prerogatives needed to resize the VM. Make sure that the VM you are about to resize belongs to a project you have access to.
[How to create a VM using the OpenStack CLI client on 3Engines Cloud cloud](../cloud/How-to-create-a-VM-using-the-OpenStack-CLI-client-on-3Engines-Cloud-cloud.html.md)
[How to create a VM using the 3Engines CLI client on 3Engines Cloud cloud](../cloud/How-to-create-a-VM-using-the-3Engines-CLI-client-on-3Engines-Cloud-cloud.html.md)
No. 2 **Awareness of existing quotas and flavors limits**
@ -35,7 +35,7 @@ Also:
> * The VM you want to resize is in an active or shut down state.
> * A flavor with the desired resource configuration exists.
> * Adequate resources are available in your OpenStack environment to accommodate the resize.
> * Adequate resources are available in your 3Engines environment to accommodate the resize.
Creating a new VM[🔗](#creating-a-new-vm "Permalink to this headline")
---------------------------------------------------------------------
@ -45,7 +45,7 @@ To illustrate the commands in this article, let us create a new VM in order to s
To see all flavors:
```
openstack flavor list
3Engines flavor list
```
@ -54,7 +54,7 @@ openstack flavor list
This is the command to create a new VM called **ResizingCLI**:
```
openstack server create \
3Engines server create \
--image "Ubuntu 22.04 LTS" \
--flavor eo2a.large \
--key-name sshkey \
@ -74,7 +74,7 @@ The **id** for **ResizingCLI** is **82bba971-8ff1-4f85-93d6-9d56bb7b185d** and w
To see all currently available VMs, use command
```
openstack server list
3Engines server list
```
@ -84,7 +84,7 @@ Steps to Resize the VM[🔗](#steps-to-resize-the-vm "Permalink to this headline
To resize a VM with CLI, there is a general command
```
openstack server resize --flavor <new_flavor> <vm_name_or_id>
3Engines server resize --flavor <new_flavor> <vm_name_or_id>
```
@ -93,14 +93,14 @@ We need flavor ID or name as well as VM’s name or id.
In this example we want to scale up the existing VM **ResizingCLI**, using **eo2.xlarge** flavor. The command will be:
```
openstack server resize --flavor eo2.xlarge ResizingCLI
3Engines server resize --flavor eo2.xlarge ResizingCLI
```
To verify the resize, check the status of the VM:
```
openstack server show ResizingCLI
3Engines server show ResizingCLI
```
@ -109,14 +109,14 @@ openstack server show ResizingCLI
When the VM has **VERIFY\_RESIZE** status, we are able to confirm the resize. The command is:
```
openstack server resize confirm ResizingCLI
3Engines server resize confirm ResizingCLI
```
Execute once again:
```
openstack server show ResizingCLI
3Engines server show ResizingCLI
```
@ -130,13 +130,13 @@ Reverting a resize switches the VM back to its original flavor and cleans up tem
It is only possible to revert a resize if the status is **VERIFY\_RESIZE**. The command would be:
```
openstack server resize revert ResizingCLI
3Engines server resize revert ResizingCLI
```
If status is not **VERIFY\_RESIZE**, we will get message stating that it is not possible to revert resize while it is in an active state (HTTP 409). In that case, perform the “regular” resizing with **openstack server resize**.
If status is not **VERIFY\_RESIZE**, we will get message stating that it is not possible to revert resize while it is in an active state (HTTP 409). In that case, perform the “regular” resizing with **3Engines server resize**.
What To Do Next[🔗](#what-to-do-next "Permalink to this headline")
-----------------------------------------------------------------
You can also resize the virtual machine using only OpenStack CLI. More details here: /openstackcli/Resizing-a-virtual-machine-using-OpenStack-Horizon-on-3Engines-Cloud
You can also resize the virtual machine using only 3Engines CLI. More details here: /3Enginescli/Resizing-a-virtual-machine-using-3Engines-Horizon-on-3Engines-Cloud

10
docs/openstackcli/Use-backup-command-to-create-rotating-backups-of-virtual-machines-on-3Engines-Cloud.html.md
View File

@ -1,7 +1,7 @@
Use backup command to create rotating backups of virtual machines on 3Engines Cloud cloud[🔗](#use-backup-command-to-create-rotating-backups-of-virtual-machines-on-brand-name-cloud "Permalink to this headline")
===================================================================================================================================================================================================================
**Rotating backups** in OpenStack refer to a backup strategy where older backups are automatically deleted after a predefined number of backups are created. This ensures that storage does not grow indefinitely while still maintaining a set number of recent backups for disaster recovery.
**Rotating backups** in 3Engines refer to a backup strategy where older backups are automatically deleted after a predefined number of backups are created. This ensures that storage does not grow indefinitely while still maintaining a set number of recent backups for disaster recovery.
The rotating backup algorithm[🔗](#the-rotating-backup-algorithm "Permalink to this headline")
---------------------------------------------------------------------------------------------
@ -20,15 +20,15 @@ Delete older backups
backup create vs. image create[🔗](#backup-create-vs-image-create "Permalink to this headline")
----------------------------------------------------------------------------------------------
There are two ways of creating backups under OpenStack, using one of these two commands:
There are two ways of creating backups under 3Engines, using one of these two commands:
**openstack server backup create** and **openstack server image create**
**3Engines server backup create** and **3Engines server image create**
Here is how they compare:
Table 3 Comparison of Backup and Image Creation Commands[🔗](#id1 "Permalink to this table")
| Feature | `openstack server backup create` | `openstack server image create` |
| Feature | `3Engines server backup create` | `3Engines server image create` |
| --- | --- | --- |
| Association with VM | Associated using **backup** image property | Associated using backup name |
| Rotation support | Rotation with `--backup-type` and incremental backups | No built-in rotation support |
@ -40,7 +40,7 @@ Table 3 Comparison of Backup and Image Creation Commands[🔗](#id1 "Permalink t
| Best usage scenario | Automated backup strategies with rotation | Capturing the current state of a VM for cloning or rollback |
| Can be scripted? | Yes | Yes |
In this article we are going to use a **openstack server backup create** command under OpenStack to create rotating backups of virtual machines.
In this article we are going to use a **3Engines server backup create** command under 3Engines to create rotating backups of virtual machines.
Prerequisites[🔗](#prerequisites "Permalink to this headline")
-------------------------------------------------------------

10
docs/openstackcli/Use-script-to-create-daily-weekly-and-monthly-rotating-backups-of-virtual-machines-using-on-3Engines-Cloud.html.md
View File

@ -1,20 +1,20 @@
Use script to create daily weekly and monthly rotating backups of virtual machines on 3Engines Cloud[🔗](#use-script-to-create-daily-weekly-and-monthly-rotating-backups-of-virtual-machines-on-brand-name "Permalink to this headline")
=========================================================================================================================================================================================================================================
**Rotating backups** in OpenStack refer to a backup strategy where older backups are automatically deleted after a predefined number of backups are created. This ensures that storage does not grow indefinitely while still maintaining a set number of recent backups for disaster recovery.
**Rotating backups** in 3Engines refer to a backup strategy where older backups are automatically deleted after a predefined number of backups are created. This ensures that storage does not grow indefinitely while still maintaining a set number of recent backups for disaster recovery.
backup create vs. image create[🔗](#backup-create-vs-image-create "Permalink to this headline")
----------------------------------------------------------------------------------------------
There are two ways of creating backups under OpenStack, using one of these two commands:
There are two ways of creating backups under 3Engines, using one of these two commands:
**openstack server backup create** and **openstack server image create**
**3Engines server backup create** and **3Engines server image create**
Here is how they compare:
Table 4 Comparison of Backup and Image Creation Commands[🔗](#id1 "Permalink to this table")
| Feature | `openstack server backup create` | `openstack server image create` |
| Feature | `3Engines server backup create` | `3Engines server image create` |
| --- | --- | --- |
| Association with VM | Associated using **backup** image property | Associated using backup name |
| Rotation support | Rotation with `--backup-type` and incremental backups | No built-in rotation support |
@ -26,7 +26,7 @@ Table 4 Comparison of Backup and Image Creation Commands[🔗](#id1 "Permalink t
| Best usage scenario | Automated backup strategies with rotation | Capturing the current state of a VM for cloning or rollback |
| Can be scripted? | Yes | Yes |
In this article, you will learn how to create multiple series of rotating backups with a script which uses multiple **OpenStackClient** commands to achieve this goal.
In this article, you will learn how to create multiple series of rotating backups with a script which uses multiple **3EnginesClient** commands to achieve this goal.
Prerequisites[🔗](#prerequisites "Permalink to this headline")
-------------------------------------------------------------

19
docs/openstackcli/openstackcli.html.md
View File

@ -1,19 +0,0 @@
# OpenStack CLI
## Available Documentation
* [How to Backup an Instance and Download it to the Desktop on 3Engines Cloud OpenStack Hosting](How-to-backup-an-instance-and-download-it-to-the-desktop-on-3Engines-Cloud.html.md)
* [How to create a set of VMs using OpenStack Heat Orchestration on 3Engines Cloud](How-to-create-a-set-of-VMs-using-OpenStack-Heat-Orchestration-on-3Engines-Cloud.html.md)
* [How to Create and Configure New Openstack Project Through Horizon on 3Engines Cloud Cloud](How-To-Create-and-Configure-New-Project-on-3Engines-Cloud-Cloud.html.md)
* [How to install OpenStackClient for Linux on 3Engines Cloud](How-to-install-OpenStackClient-for-Linux-on-3Engines-Cloud.html.md)
* [How to install OpenStackClient GitBash for Windows on 3Engines Cloud](How-to-install-OpenStackClient-GitBash-or-Cygwin-for-Windows-on-3Engines-Cloud.html.md)
* [How to share private container from object storage to another user on 3Engines Cloud](How-to-share-private-container-from-object-storage-to-another-user-on-3Engines-Cloud.html.md)
* [How to install OpenStackClient on Windows using Windows Subsystem for Linux on 3Engines Cloud OpenStack Hosting](How-to-install-OpenStackClient-on-Windows-using-Windows-Subsystem-for-Linux-on-3Engines-Cloud-OpenStack-Hosting.html.md)
* [How to move data volume between VMs using OpenStack CLI on 3Engines Cloud](How-to-move-data-volume-between-two-VMs-using-OpenStack-CLI-on-3Engines-Cloud.html.md)
* [How to access object storage using OpenStack CLI on 3Engines Cloud](How-to-access-object-storage-using-OpenStack-CLI-on-3Engines-Cloud.html.md)
* [How to transfer volumes between domains and projects using OpenStack CLI client on 3Engines Cloud](How-to-transfer-volumes-between-domains-and-projects-using-OpenStack-CLI-client-on-3Engines-Cloud.html.md)
* [How to start a VM from instance snapshot using OpenStack CLI on 3Engines Cloud](How-to-start-a-VM-from-instance-snapshot-using-OpenStack-CLI-on-3Engines-Cloud.html.md)
* [How to create instance snapshot using OpenStack CLI on 3Engines Cloud](How-to-create-instance-snapshot-using-OpenStack-CLI-on-3Engines-Cloud.html.md)
* [Resizing a virtual machine using OpenStack CLI on 3Engines Cloud](Resizing-a-virtual-machine-using-OpenStack-CLI-on-3Engines-Cloud.html.md)
* [Use backup command to create rotating backups of virtual machines on 3Engines Cloud cloud](Use-backup-command-to-create-rotating-backups-of-virtual-machines-on-3Engines-Cloud.html.md)
* [Use script to create daily weekly and monthly rotating backups of virtual machines on 3Engines Cloud](Use-script-to-create-daily-weekly-and-monthly-rotating-backups-of-virtual-machines-using-on-3Engines-Cloud.html.md)