isle/docs/admin/adding-a-host-to-the-network.md

# Adding a Host to the Network

This document guides an admin through adding a single host to the network. Keep
in mind that the steps described here must be done for _each_ host the user
wishes to add.

## Step 1: Choose Hostname

The user will need to provide you with a name for their host. The name should
conform to the following rules:

* It should only contain lowercase letters, numbers, and hyphens.

* It should begin with a letter.

* It should end with a letter or number.

## Step 2: Choose IP

The admin should choose an IP for the host. The IP you choose for the new host
should be one which is not yet used by any other host and is in a subnet which
was configured when creating the network.

## Step 3: Create a `bootstrap.json` File

To create a `bootstrap.json` file for the new host, the admin should perform the
following command from their own host:

```
isle hosts create \
    --hostname <name> \
    --ip <ip> \
    > bootstrap.json
```

The resulting `bootstrap.json` file should be treated as a secret file and
shared only with the user it was generated for. The `bootstrap.json` file should
not be re-used between hosts.

The user can now proceed with calling `isle network join`, as described in the
[Getting Started][getting-started] document.

[getting-started]: ../user/getting-started.md
First public commit There has been over 1 year of commit history leading up to this point, but almost all of that has had some kind network configuration or secrets built into the code. As of today all of that has been removed, and the codebase can finally be published! I am keeping a private copy of the previous commit history, though it's unclear if it will ever be able to be published. 2021-04-20 21:31:37 +00:00			`# Adding a Host to the Network`

			`This document guides an admin through adding a single host to the network. Keep`
			`in mind that the steps described here must be done for _each_ host the user`
			`wishes to add.`

			`## Step 1: Choose Hostname`

			`The user will need to provide you with a name for their host. The name should`
			`conform to the following rules:`

			`* It should only contain lowercase letters, numbers, and hyphens.`

			`* It should begin with a letter.`

			`* It should end with a letter or number.`

Updates to existing documentation 2022-10-30 00:22:03 +00:00			`## Step 2: Choose IP`
First public commit There has been over 1 year of commit history leading up to this point, but almost all of that has had some kind network configuration or secrets built into the code. As of today all of that has been removed, and the codebase can finally be published! I am keeping a private copy of the previous commit history, though it's unclear if it will ever be able to be published. 2021-04-20 21:31:37 +00:00
			`The admin should choose an IP for the host. The IP you choose for the new host`
Update documentation 2024-07-07 11:37:26 +00:00			`should be one which is not yet used by any other host and is in a subnet which`
			`was configured when creating the network.`
First public commit There has been over 1 year of commit history leading up to this point, but almost all of that has had some kind network configuration or secrets built into the code. As of today all of that has been removed, and the codebase can finally be published! I am keeping a private copy of the previous commit history, though it's unclear if it will ever be able to be published. 2021-04-20 21:31:37 +00:00
Use JSON instead of YAML for files which aren't intended for human editing 2024-06-10 16:56:36 +00:00			## Step 3: Create a `bootstrap.json` File
First public commit There has been over 1 year of commit history leading up to this point, but almost all of that has had some kind network configuration or secrets built into the code. As of today all of that has been removed, and the codebase can finally be published! I am keeping a private copy of the previous commit history, though it's unclear if it will ever be able to be published. 2021-04-20 21:31:37 +00:00
Use JSON instead of YAML for files which aren't intended for human editing 2024-06-10 16:56:36 +00:00			To create a `bootstrap.json` file for the new host, the admin should perform the
First public commit There has been over 1 year of commit history leading up to this point, but almost all of that has had some kind network configuration or secrets built into the code. As of today all of that has been removed, and the codebase can finally be published! I am keeping a private copy of the previous commit history, though it's unclear if it will ever be able to be published. 2021-04-20 21:31:37 +00:00			`following command from their own host:`

			```
Move create-bootstrap logic into daemon, rename to hosts create 2024-07-13 14:31:52 +00:00			`isle hosts create \`
Add Name field to admin.CreationParams 2022-11-05 11:34:49 +00:00			`--hostname <name> \`
Updates to existing documentation 2022-10-30 00:22:03 +00:00			`--ip <ip> \`
Use JSON instead of YAML for files which aren't intended for human editing 2024-06-10 16:56:36 +00:00			`> bootstrap.json`
First public commit There has been over 1 year of commit history leading up to this point, but almost all of that has had some kind network configuration or secrets built into the code. As of today all of that has been removed, and the codebase can finally be published! I am keeping a private copy of the previous commit history, though it's unclear if it will ever be able to be published. 2021-04-20 21:31:37 +00:00			```

Update documentation 2024-07-07 11:37:26 +00:00			The resulting `bootstrap.json` file should be treated as a secret file and
Use JSON instead of YAML for files which aren't intended for human editing 2024-06-10 16:56:36 +00:00			shared only with the user it was generated for. The `bootstrap.json` file should
Update documentation 2024-07-07 11:37:26 +00:00			`not be re-used between hosts.`

			The user can now proceed with calling `isle network join`, as described in the
			`[Getting Started][getting-started] document.`
First public commit There has been over 1 year of commit history leading up to this point, but almost all of that has had some kind network configuration or secrets built into the code. As of today all of that has been removed, and the codebase can finally be published! I am keeping a private copy of the previous commit history, though it's unclear if it will ever be able to be published. 2021-04-20 21:31:37 +00:00
Update documentation 2024-07-07 11:37:26 +00:00			`[getting-started]: ../user/getting-started.md`