| Name | elemento-cli JSON |
| Version |
0.2.1
JSON |
| download |
| home_page | https://elemento.cloud |
| Summary | CLI for Elemento |
| upload_time | 2024-09-24 13:34:18 |
| maintainer | None |
| docs_url | None |
| author | Elemento |
| requires_python | >=3.9 |
| license | GPL |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<br/>
<br/>
<br/>
<img src="https://raw.githubusercontent.com/Elemento-Modular-Cloud/graphic-assets/main/logos/horizontal/Logo%20horizontal%20lightbg%20transp.svg" width=50%/>
<br/>
# Elemento command line overview
###### tags: `elemento` `CLI` `tech` `CTO` `tutorials`
<style>
h1, h2, h3, h4, h5, h6, h7, p, a {
font-family: Arial, Helvetica, sans-serif;
}
</style>
# Elemento command line overview
## Authentication
Before using the Elemento CLI you would need to **authenticate**!
`elemento auth login`
Do you have an **account**? No, [create yours here](https://elemento.typeform.com/to/p3zAUodM)
**Forgot** your password? [Recover it here](https://portal.elemento.cloud/api/v1/user/recovery)
`elemento auth logout`
## Info about daemons
`elemento info` will tell you if the daemons are running properly.
It is possible to get the client daemons from
- Mac https://repo.elemento.cloud/app/Elemento_daemons.dmg
- Windows https://repo.elemento.cloud/app/Elemento_daemons.zip
- Linux https://github.com/Elemento-Modular-Cloud/electros
## Account Management
To use AtomOS you will need a License: [buy yours here](https://elemento.typeform.com/to/rUaZRm2O)!
From the CLI you can **list** your licenses
`elemento account list_licenses`
or **activate** one. AtomOS licenses become active and ready when you activate them, not when you buy them.
`elemento account activate_license --key `
the CLI will download your license and you'll find a *atomos.license* file:
- **keep it in a safe place!**
- copy it in */etc/elemento/atomos.license* path of your server (one license per server)
- restart the *elementolicensing* service `systemctl restart elementolicensing`
## Volumes
You can **list** your volumes.
`elemento volume list`
:::spoiler Pro Tip
Volumes will be searched in `/mnt/elemento-vault`, mount here your volumes!
:::
If you have not any volume you can ask if there is any server ready to create one for you
`elemento volume cancreate --size 1`
and then **create** or even **destroy** your volumes
`elemento volume create --size 1`
(Read our [tech pack](https://hackmd.io/REBdz_zXT9Koqcel-LbBJg) for a complete list of volume specification)
`elemento volume destroy fffffffffffffffffffffffffffffffff`
## Virtual Machines
You can manage your own volumes or **download** a standard *iso* image
`elemento vm getiso`
:::spoiler *iso* files
This command will download a file calles {os_flavour}.iso in /tmp and you can run vmw from this if using the Live image!
:::
then you can create your machine
`elemento vm create --spec-json /path/to/request.json --volumes-json /path/to/volumes.json`
(Read our [tech pack](https://hackmd.io/REBdz_zXT9Koqcel-LbBJg) for a complete list of volume specification)
## Templates
List some machines templates
`elemento vm gettemplates`
**List** your vms
`elemento vm list`
you will notice a SW and a HW link in the form *https://localhost:8443/#/clients/...* these will open a screen to manage your machines directly form your browser.
In order to use the software link you need to enable VNC (on Linux) or RDP (on Windows) with an account *elemento*.
or **destroy** them
`elemento vm destroy fffffffffffffffffffffffffffffffff`
## Community Edition
If you are interacting with servers running the *Community Edition* they will not be automacically discovered.
:::success
Before running the daemons put your server IP in `$HOME/.elemento/hosts`
:::
# AtomOS - server side
# Services
## Resource matcher server
`sudo systemctl status matcherserver`
## Storage server
`sudo systemctl status storageserver`
### Elemento paths
The **storageserver** searches Elemento volumes (*.elimg*) in */mnt*.
Add a new drive
- mount the drive in */mnt*
- add a *settings.json* in the new path specifing the number of VM volumes and their total size (in GB) as follows
```
{
"max-volumes": 1,
"max-size": 1000
}
```
Example of configuration
```
|/mnt
|/mnt/elemento-vault
|/mnt/elemento-vault/settings.json
```
## Licensing
First of all grab your [license](https://elemento.typeform.com/to/rUaZRm2O), activate it with the command line
`elemento account activate_license --key `
the CLI will download your license and you'll find a *atomos.license* file:
- **keep it in a safe place!**
- copy it in */etc/elemento/atomos.license* path of your server (one license per server)
- restart the *elementolicensing* service `systemctl restart elementolicensing`
Check the status of your service `sudo systemctl status elementolicensing`
# Doubts? Need help?
Open an *issue* in our [helpcenter](https://github.com/Elemento-Modular-Cloud/helpcenter)
Raw data
{
"_id": null,
"home_page": "https://elemento.cloud",
"name": "elemento-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Elemento",
"author_email": "hello@elemento.cloud",
"download_url": "https://files.pythonhosted.org/packages/af/05/c5f335d5ce2b7555f334a8926be419896be58891215df926d1ad2b16bda6/elemento_cli-0.2.1.tar.gz",
"platform": null,
"description": "<br/>\n<br/>\n<br/>\n<img src=\"https://raw.githubusercontent.com/Elemento-Modular-Cloud/graphic-assets/main/logos/horizontal/Logo%20horizontal%20lightbg%20transp.svg\" width=50%/>\n<br/>\n\n# Elemento command line overview\n\n###### tags: `elemento` `CLI` `tech` `CTO` `tutorials`\n\n<style>\n h1, h2, h3, h4, h5, h6, h7, p, a {\n font-family: Arial, Helvetica, sans-serif;\n }\n</style>\n\n\n# Elemento command line overview\n\n## Authentication\nBefore using the Elemento CLI you would need to **authenticate**!\n\n`elemento auth login`\n\nDo you have an **account**? No, [create yours here](https://elemento.typeform.com/to/p3zAUodM)\n\n**Forgot** your password? [Recover it here](https://portal.elemento.cloud/api/v1/user/recovery)\n\n`elemento auth logout`\n\n## Info about daemons\n\n`elemento info` will tell you if the daemons are running properly.\n\nIt is possible to get the client daemons from\n- Mac https://repo.elemento.cloud/app/Elemento_daemons.dmg\n- Windows https://repo.elemento.cloud/app/Elemento_daemons.zip\n- Linux https://github.com/Elemento-Modular-Cloud/electros\n\n## Account Management\n\nTo use AtomOS you will need a License: [buy yours here](https://elemento.typeform.com/to/rUaZRm2O)!\n\nFrom the CLI you can **list** your licenses\n\n`elemento account list_licenses`\n\nor **activate** one. AtomOS licenses become active and ready when you activate them, not when you buy them.\n\n`elemento account activate_license --key `\n\nthe CLI will download your license and you'll find a *atomos.license* file:\n- **keep it in a safe place!**\n- copy it in */etc/elemento/atomos.license* path of your server (one license per server)\n- restart the *elementolicensing* service `systemctl restart elementolicensing`\n\n## Volumes\n\nYou can **list** your volumes.\n\n`elemento volume list`\n\n:::spoiler Pro Tip\nVolumes will be searched in `/mnt/elemento-vault`, mount here your volumes!\n:::\n\nIf you have not any volume you can ask if there is any server ready to create one for you\n\n`elemento volume cancreate --size 1`\n\nand then **create** or even **destroy** your volumes\n\n`elemento volume create --size 1`\n\n(Read our [tech pack](https://hackmd.io/REBdz_zXT9Koqcel-LbBJg) for a complete list of volume specification)\n\n`elemento volume destroy fffffffffffffffffffffffffffffffff`\n\n## Virtual Machines\n\nYou can manage your own volumes or **download** a standard *iso* image\n`elemento vm getiso`\n\n:::spoiler *iso* files\nThis command will download a file calles {os_flavour}.iso in /tmp and you can run vmw from this if using the Live image!\n:::\n\nthen you can create your machine\n\n`elemento vm create --spec-json /path/to/request.json --volumes-json /path/to/volumes.json`\n\n(Read our [tech pack](https://hackmd.io/REBdz_zXT9Koqcel-LbBJg) for a complete list of volume specification)\n\n## Templates\nList some machines templates\n`elemento vm gettemplates`\n\n**List** your vms\n\n`elemento vm list`\n\nyou will notice a SW and a HW link in the form *https://localhost:8443/#/clients/...* these will open a screen to manage your machines directly form your browser.\nIn order to use the software link you need to enable VNC (on Linux) or RDP (on Windows) with an account *elemento*.\n\nor **destroy** them\n\n`elemento vm destroy fffffffffffffffffffffffffffffffff`\n\n\n## Community Edition\nIf you are interacting with servers running the *Community Edition* they will not be automacically discovered.\n\n:::success\nBefore running the daemons put your server IP in `$HOME/.elemento/hosts`\n:::\n\n# AtomOS - server side\n\n# Services\n\n## Resource matcher server\n\n`sudo systemctl status matcherserver`\n\n## Storage server\n\n`sudo systemctl status storageserver`\n\n### Elemento paths\n\nThe **storageserver** searches Elemento volumes (*.elimg*) in */mnt*.\n\nAdd a new drive\n- mount the drive in */mnt*\n- add a *settings.json* in the new path specifing the number of VM volumes and their total size (in GB) as follows\n\n```\n{\n \"max-volumes\": 1,\n \"max-size\": 1000\n}\n```\n\nExample of configuration\n\n```\n|/mnt\n|/mnt/elemento-vault\n|/mnt/elemento-vault/settings.json\n```\n\n## Licensing\n\nFirst of all grab your [license](https://elemento.typeform.com/to/rUaZRm2O), activate it with the command line\n\n\n`elemento account activate_license --key `\n\nthe CLI will download your license and you'll find a *atomos.license* file:\n- **keep it in a safe place!**\n- copy it in */etc/elemento/atomos.license* path of your server (one license per server)\n- restart the *elementolicensing* service `systemctl restart elementolicensing`\n\nCheck the status of your service `sudo systemctl status elementolicensing`\n\n\n# Doubts? Need help?\n\nOpen an *issue* in our [helpcenter](https://github.com/Elemento-Modular-Cloud/helpcenter)\n",
"bugtrack_url": null,
"license": "GPL",
"summary": "CLI for Elemento",
"version": "0.2.1",
"project_urls": {
"Homepage": "https://elemento.cloud"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6623c1f7eff09a0673e1802549bebe112373fc010a80db2a4eae33a1cc67fff1",
"md5": "826c71ca72d8c45e2459f057e79b3faa",
"sha256": "bc503a19bff2358cd9c90d9c499507d7b3bf331534945da414117f63c9f961cb"
},
"downloads": -1,
"filename": "elemento_cli-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "826c71ca72d8c45e2459f057e79b3faa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 72456,
"upload_time": "2024-09-24T13:34:17",
"upload_time_iso_8601": "2024-09-24T13:34:17.502171Z",
"url": "https://files.pythonhosted.org/packages/66/23/c1f7eff09a0673e1802549bebe112373fc010a80db2a4eae33a1cc67fff1/elemento_cli-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "af05c5f335d5ce2b7555f334a8926be419896be58891215df926d1ad2b16bda6",
"md5": "e766d1822badac223d605834bbdab2e0",
"sha256": "8dcba9f75f72ac86e4c289a00a077b8a66da1585309981598f52c3cb165ed98e"
},
"downloads": -1,
"filename": "elemento_cli-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "e766d1822badac223d605834bbdab2e0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 48772,
"upload_time": "2024-09-24T13:34:18",
"upload_time_iso_8601": "2024-09-24T13:34:18.967122Z",
"url": "https://files.pythonhosted.org/packages/af/05/c5f335d5ce2b7555f334a8926be419896be58891215df926d1ad2b16bda6/elemento_cli-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-24 13:34:18",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "elemento-cli"
}
