Spearhead/docs.spearhead.cloud
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

updated content

Browse Source
This commit is contained in:
Marius Pana 2018-07-26 19:53:53 +03:00
parent bef07147d8
commit bf35e857a9
14 changed files with 53 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
en/docs/cloud-portal.md
View File

@ -3,3 +3,5 @@
> Get started with the Spearhead Cloud today. Sign-up for a [free trial](https://spearhead.cloud/trial). > Get started with the Spearhead Cloud today. Sign-up for a [free trial](https://spearhead.cloud/trial).
> This part of our documentation is still being worked on. If we can help you in the meantime please send an email to [help@spearhead.cloud](mailto:help@spearhead.cloud). > This part of our documentation is still being worked on. If we can help you in the meantime please send an email to [help@spearhead.cloud](mailto:help@spearhead.cloud).
> Last edit: 2018 Thu 26 Jul 19:48 GMT+3

2
en/docs/connecting.md
View File

@ -17,3 +17,5 @@ TBD: Click here for detailed information on how to SSH into your instance.
All windows instances are preconfigured with RDP access enabled for the Administrator account. Obtain the IP address of your instance and then connect using your preferred RDP client. All windows instances are preconfigured with RDP access enabled for the Administrator account. Obtain the IP address of your instance and then connect using your preferred RDP client.
```spearhead instance get <short-id or name>``` and look for the primaryIP field. ```spearhead instance get <short-id or name>``` and look for the primaryIP field.
> Last edit: 2018 Thu 26 Jul 19:48 GMT+3

2
en/docs/containers.md
View File

@ -1,3 +1,5 @@
# Containers # Containers
> We are busy creating documentation. Please note we adhere to most of [Docker's 1.22 spec](https://docs.docker.com/engine/api/v1.22/). > We are busy creating documentation. Please note we adhere to most of [Docker's 1.22 spec](https://docs.docker.com/engine/api/v1.22/).
> Last edit: 2018 Thu 26 Jul 19:48 GMT+3

6
en/docs/datacenters.md
View File

@ -1,7 +1,7 @@
# Data centers # Data centers
>A datacenter in the Spearhead Cloud is also an API endpoint which you can manage via the [Spearhead Cloud Tools](https://docs.spearhead.cloud/cloud-portal). >A datacenter in the Spearhead Cloud is also an API endpoint which you can manage via the [Spearhead Cloud Tools](https://docs.spearhead.cloud/cloud-portal).
> As of March 2018 only the [ro-1 datacenter](https://eu-ro-1.api.spearhead.cloud) is active. Please note that the certificate is self-signed! You must use --insecure for the Spearhead Cloud CLI Tools and/or --tls when using spearhead-docker/docker commands. > As of March 2018 the [ro-1 datacenter](https://eu-ro-1.api.spearhead.cloud) is active. Please note that you should download the latest [cacert.pem](https://curl.haxx.se/docs/caextract.html) from curl.haxx.se and export `export CURL_CA_BUNDLE=~/Downloads/cacert.pem` when using spearhead-compose commands.
Here is our list of public datacenters. Here is our list of public datacenters.
@ -32,5 +32,7 @@ Located in Sofia, Bulgaria.
* CloudAPI endpoint: ```https://ro-1.spearhead.cloud``` * CloudAPI endpoint: ```https://ro-1.spearhead.cloud```
## Spearhead CNS ## Spearhead CNS
* Public interfaces: ```tbd.``` * Public interfaces: ```ro-1.on.spearhead.cloud```
* Private interfaces: ```tbd.``` * Private interfaces: ```tbd.```
> Last edit: 2018 Thu 26 Jul 19:48 GMT+3

19
en/docs/dns.md
View File

@ -14,12 +14,23 @@ Spearhead CNS offers two facilities:
1. Serving address records for instances by instance name. 1. Serving address records for instances by instance name.
2. Serve address records for instances grouped by service label/tag (multiple instances are listed in one DNS name, depending on their availability) 2. Serve address records for instances grouped by service label/tag (multiple instances are listed in one DNS name, depending on their availability)
Once activated, running instances in Spearhead Compute Service with public network interfaces will be available in DNS using the following FQDN patterns: Once activated, running instances in Spearhead Compute Service will be available in DNS using the following FQDN patterns:
<instance name OR alias>.inst.<account uuid OR login_name>.<data center name>.spearhead.cloud <instance name OR alias>.inst.<account uuid OR login_name>.<data center name>.spearhead.cloud
<service name>.svc.<account uuid OR login_name>.<data center name>.spearhead.cloud <service name>.svc.<account uuid OR login_name>.<data center name>.spearhead.cloud
> DNS names for instances are currently unavaiable from the Spearhead Cloud Tools (```spearhead get <instance name>```). It is possible to retrieve them by getting the instance name and running dig against the known format domain. Here is an example output from `spearhead instance get` <name>:
```
"dns_names": [
"11163447-6bc4-4d5f-a168-9981824857c9.inst.41824237-4616-42e3-d189-f9bd0242b4e4.ro-1.on.spearhead.cloud",
"mpana-fab-lan.11163447-6bc4-4d5f-a168-9981824857c9.inst.41824237-4616-42e3-d189-f9bd0242b4e4.ro-1.on.spearhead.cloud",
"11163447-6bc4-4d5f-a168-9981824857c9.inst.mpana.ro-1.on.spearhead.cloud",
"mpana-fab-lan.11163447-6bc4-4d5f-a168-9981824857c9.inst.mpana.ro-1.on.spearhead.cloud",
"cinema.inst.41824237-4616-42e3-d189-f9bd0242b4e4.ro-1.on.spearhead.cloud",
"mpana-fab-lan.cinema.inst.41824237-4616-42e3-d189-f9bd0242b4e4.ro-1.on.spearhead.cloud",
"cinema.inst.mpana.ro-1.on.spearhead.cloud",
"mpana-fab-lan.cinema.inst.mpana.ro-1.on.spearhead.cloud"
]
```
> Last edit: 2018 Thu 26 Jul 19:48 GMT+3
> Last edit: 2018 Wed 11 Jul 16:44 GMT+3

2
en/docs/firewall.md
View File

@ -79,3 +79,5 @@ More details regarding the fwrules options can be found using ```spearhead fwrul
#### Enabling and Disabling firewall rules #### Enabling and Disabling firewall rules
Firewall rules can be enabled or disabled as required. This can be achievied using the ```spearhead fwrule enable <FWRULE ID>```. Alternatively, disabling a rule would be ```spearhead fwrule disable <FWRULE ID>```. Firewall rules can be enabled or disabled as required. This can be achievied using the ```spearhead fwrule enable <FWRULE ID>```. Alternatively, disabling a rule would be ```spearhead fwrule disable <FWRULE ID>```.
> Last edit: 2018 Thu 26 Jul 19:48 GMT+3

6
en/docs/index.md
View File

@ -21,8 +21,14 @@ Our virtualization technology is based on the well known KVM virtualization stac
### Network ### Network
Spearhead Cloud provides a complete software-defined-networking stack allowing for full IP stacks, easy management and high performance. Spearhead Cloud provides a complete software-defined-networking stack allowing for full IP stacks, easy management and high performance.
### Volumes
Spearhead Cloud provides volumes which can be used to store data that can be read or written by any of your instances (hardware virtual machines, infrastructure containers and/or Docker containers).
### Security ### Security
Spearhead Cloud leverages well known Zones technology to keep tenants from seeing each others data but also assures that everyone gets their share of the resources. Spearhead Cloud leverages well known Zones technology to keep tenants from seeing each others data but also assures that everyone gets their share of the resources.
### Debugging and Visibility ### Debugging and Visibility
Spearhead Cloud provides complete visibility for your systems and applications though dynamic tracing, complex monitoring and native docker logging. Spearhead Cloud provides complete visibility for your systems and applications though dynamic tracing, complex monitoring and native docker logging.
> Last edit: 2018 Thu 26 Jul 19:48 GMT+3

1
en/docs/infrastructure-containers.md
View File

@ -9,3 +9,4 @@ Infrastructure containers also offer elasticity allowing you to scale from one i
The high performance of infrastructure containers is due to the fact that we run directly on bare metal without any virtualization overhead. The high performance of infrastructure containers is due to the fact that we run directly on bare metal without any virtualization overhead.
> Last edit: 2018 Thu 26 Jul 19:48 GMT+3

6
en/docs/network.md
View File

@ -9,10 +9,10 @@ Spearhead Cloud provides two types of networks by default.
1. **Networks defined by us**. These are networks we create for tasks such as providing internet access or for private access (non-routable). These networks are usually shared by many customers. 1. **Networks defined by us**. These are networks we create for tasks such as providing internet access or for private access (non-routable). These networks are usually shared by many customers.
2. **Networks defined by you**. These types of networks are sometimes called VXLAN or overlay networks. These networks are private and may be used to isolate applications or segments of your virtual network topology. 2. **Networks defined by you**. These types of networks are sometimes called VXLAN or overlay networks. These networks are private and may be used to isolate applications or segments of your virtual network topology.
> Spearhead Cloud creates a default VLAN with id 2 in all datacenters. > Spearhead Cloud creates a default VLAN with id 2 in all datacenters. This network is private and only accesible by your instances.
## Public network ## Public network
Spearhead Cloud provides a public network named "External" which you can use to attach your vm's to for direct public Internet access. At present you must explicitly specify the External network otherwise provisioning may fail. Spearhead Cloud provides a public network named "External" which you can use to attach your vm's to for direct public Internet access.
Here is an example provisioning an instance explicitly using the External network: Here is an example provisioning an instance explicitly using the External network:
@ -24,4 +24,4 @@ Here is an example of launching a docker container with a full IP stack on the p
Docker containers require explicit mapping of networks/ports. If you do not specify a network, the default fabric vlan will be used (i.e. no public IP for your containers). Docker containers require explicit mapping of networks/ports. If you do not specify a network, the default fabric vlan will be used (i.e. no public IP for your containers).
While our documentation is being written please contact [customer support](mailto:help@spearhead.systems) for additional details. > Last edit: 2018 Thu 26 Jul 19:51 GMT+3

2
en/docs/spearhead-cli.md
View File

@ -100,3 +100,5 @@ spearhead instance create \
``` ```
### instance details ### instance details
To view all of your instance's details run ```spearhead instance get -j some-instance```. This will give you a full JSON blob of your instance details. You can optionally pipe the instance details output through the ```json``` command and parse or perform other operations. To view all of your instance's details run ```spearhead instance get -j some-instance```. This will give you a full JSON blob of your instance details. You can optionally pipe the instance details output through the ```json``` command and parse or perform other operations.
> Last edit: 2018 Thu 26 Jul 19:48 GMT+3

3
en/docs/spearhead-docker-cli.md
View File

@ -36,4 +36,5 @@ To complete the installation, run *sudo spearhead-docker-install* to install the
## Usage ## Usage
Once installed, use *spearhead-docker* and *spearhead-compose* in place of docker and docker-compose when interacting with the Spearhead Cloud. Once installed, use *spearhead-docker* and *spearhead-compose* in place of docker and docker-compose when interacting with the Spearhead Cloud.
https://docs.joyent.com/public-cloud/instances/docker/how#networks
> Last edit: 2018 Thu 26 Jul 19:48 GMT+3

4
en/docs/start.md
View File

@ -11,7 +11,7 @@ This document will describe how to set-up a Spearhead Cloud account.
1. Create a [Spearhead Cloud account](https://spearhead.cloud/start). 1. Create a [Spearhead Cloud account](https://spearhead.cloud/start).
2. Add your SSH key(s). 2. Add your SSH key(s).
That is it. Now you are ready to start working with the Spearhead Cloud. Now you are ready to start working with the Spearhead Cloud.
### SSH Keys ### SSH Keys
You can use your existing key or create a new one in the Spearhead Cloud Portal. You can use your existing key or create a new one in the Spearhead Cloud Portal.
@ -41,3 +41,5 @@ You may add your key at a later time by visiting your Profile settings in the Cl
* Infrastructure container images - are container native Linux and SmartOS systems running on bare-metal. These offer high performance, scalability by allowing on-line resizing and security. Take advantage of preconfigured images for many scopes such as databases and web servers. * Infrastructure container images - are container native Linux and SmartOS systems running on bare-metal. These offer high performance, scalability by allowing on-line resizing and security. Take advantage of preconfigured images for many scopes such as databases and web servers.
* Hardware virtual machines - these are typical virtual machines that run using KVM. We provide these for legacy systems or workloads that cannot be deployed as containers. * Hardware virtual machines - these are typical virtual machines that run using KVM. We provide these for legacy systems or workloads that cannot be deployed as containers.
* package(s) - packages define the resources allocated to an instance. * package(s) - packages define the resources allocated to an instance.
> Last edit: 2018 Thu 26 Jul 19:48 GMT+3

8
en/docs/startstop.md
View File

@ -1,5 +1,5 @@
# Start and stopping instances # Start and stopping instances
Before you can use the Spearhead Cloud you must create and account and provide your billing details. Before you can use the Spearhead Cloud you must create an account and provide your billing details.
## Using the Spearhead Cloud Portal ## Using the Spearhead Cloud Portal
TBD: shortly TBD: shortly
@ -15,7 +15,7 @@ Now you can use the ```spearhead``` command to create your infrastructure contai
The command parameters define: The command parameters define:
1. -n (--name) provides the name of the container. In our case it is "webdeb". 1. -n (--name) provides the name of the container. In our case it is "webdeb".
2. -w "waits" for the container to be created before returning the prompt. 2. -w "waits" for the instance to be created before returning the prompt.
3. We are using debian-8 as our image<sub>1</sub>. 3. We are using debian-8 as our image<sub>1</sub>.
4. We are using s1-general-1-2-100 as our package<sub>2</sub>. 4. We are using s1-general-1-2-100 as our package<sub>2</sub>.
@ -31,7 +31,7 @@ Once you are finished using your instances you can delete them using the ```spea
Using the ```spearhead``` cli tool is the most convenient way to quickly delete your instances (including Docker containers). By issuing ```spearhead instance delete <UUID>``` you can remove any instance including Docker containers. Using the ```spearhead``` cli tool is the most convenient way to quickly delete your instances (including Docker containers). By issuing ```spearhead instance delete <UUID>``` you can remove any instance including Docker containers.
### Delete using the Spearhead Cloud Portal ### Delete using the Spearhead Cloud Portal
To delete an instance using the Spearhead Cloud Portal TBD: To delete an instance using the Spearhead Cloud Portal
# Restart policies # Restart policies
@ -53,3 +53,5 @@ When restarting your container automatically (the cases mentioned above) there i
The main way that this is different from Docker Inc's docker is that with Docker Inc's docker, if you restart the docker daemon all containers will be stopped and those with --restart=always will be started again. With spearhead-docker restarting the management systems will not touch your container but restarting the compute node the container lives on will. The main way that this is different from Docker Inc's docker is that with Docker Inc's docker, if you restart the docker daemon all containers will be stopped and those with --restart=always will be started again. With spearhead-docker restarting the management systems will not touch your container but restarting the compute node the container lives on will.
If you want your container to always be running you most likely want to specify --restart=always to avoid your containers being stopped when a CN reboots. If you want your container to always be running you most likely want to specify --restart=always to avoid your containers being stopped when a CN reboots.
> Last edit: 2018 Thu 26 Jul 19:50 GMT+3

2
en/docs/vms.md
View File

@ -1,3 +1,5 @@
# Virtual Machines # Virtual Machines
> We are busy creating documentation. > We are busy creating documentation.
> Last edit: 2018 Thu 26 Jul 19:48 GMT+3