You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
provisioning-*: add information on how to connect via SSH
As discussed in coreos#186 the provisioning pages now contain information on how to
connect to the newly spawned VMs.
Additionally, formatting is further standardized between some pages and the
Ignition/Afterburn information is also added to the authentication/default user
page.
The AWS example was split into two to make editing them easier going forward.
Fixes some references to outdated external tools (`gcloud compute ssh`, `govc`)
as well.
Fixescoreos#186
Copy file name to clipboardExpand all lines: modules/ROOT/pages/authentication.adoc
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,8 @@
4
4
5
5
By default, a privileged user named `core` is created on the Fedora CoreOS system, but it is not configured with a default password or SSH key. If you wish to use the `core` user, you must provide an Ignition config which includes a password and/or SSH key(s) for the `core` user. Alternatively you may create additional, new users via Ignition configs.
6
6
7
+
If you do not want to use Ignition to manage the default user's SSH key(s), you can make use of the https://coreos.github.io/afterburn/platforms/[Afterburn support] and provide an SSH key via your cloud provider.
8
+
7
9
== Creating a New User
8
10
9
11
To create a new user (or users), add it to the `users` list of your Butane config. In the following example, the config creates two new usernames, but doesn't configure them to be especially useful.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/getting-started-aws.adoc
+2-24Lines changed: 2 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,30 +33,8 @@ TIP: You can find out the instance's assigned IP by running `aws ec2 describe-in
33
33
34
34
You now should be able to SSH into the instance using the associated IP address.
35
35
36
-
In order to launch a customized FCOS instance, a valid Ignition configuration must be passed as its https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html#instancedata-add-user-data[user data] at creation time. You can use the same command from above but add `--user-data file://path/to/config.ign` argument:
37
-
38
-
.Launching and customizing a new instance
36
+
.Example connecting
39
37
[source, bash]
40
38
----
41
-
NAME='instance1'
42
-
SSHKEY='my-key' # the name of your SSH key: `aws ec2 describe-key-pairs`
43
-
IMAGE='ami-xxx' # the AMI ID found on the download page
44
-
DISK='20' # the size of the hard disk
45
-
REGION='us-east-1' # the target region
46
-
TYPE='m5.large' # the instance type
47
-
SUBNET='subnet-xxx' # the subnet: `aws ec2 describe-subnets`
48
-
SECURITY_GROUPS='sg-xx' # the security group `aws ec2 describe-security-groups`
49
-
USERDATA='/path/to/config.ign' # path to your Ignition config
NOTE: By design, cloud-init configuration and startup scripts are not supported on FCOS. Instead, it is recommended to encode any startup logic as systemd service units in the Ignition configuration.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/getting-started-libvirt.adoc
+7Lines changed: 7 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,3 +42,10 @@ NOTE: Depending on your version of `virt-install`, you may not be able to use `-
42
42
TIP: Make sure that your user has access to `/dev/kvm`. The default is to allow access for everyone, but on some distributions you may need to add yourself to the `kvm` group.
43
43
44
44
TIP: You can escape out of the serial console by pressing `CTRL + ]`.
45
+
46
+
If you set up an xref:authentication.adoc[SSH key] for the default `core` user, you can SSH into the VM and explore the OS:
Copy file name to clipboardExpand all lines: modules/ROOT/pages/provisioning-aliyun.adoc
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,9 @@ This guide shows how to provision new Fedora CoreOS (FCOS) nodes on Alibaba Clou
6
6
7
7
Before provisioning an FCOS machine, you must have an Ignition configuration file containing your customizations. If you do not have one, see xref:producing-ign.adoc[Producing an Ignition File].
8
8
9
-
If you do not want to use Ignition to get started, you can make use of the https://coreos.github.io/afterburn/platforms/[Afterburn support] and provide an SSH key via the cloud provider and continue from there.
9
+
NOTE: Fedora CoreOS has a default `core` user that can be used to explore the OS. If you want to use it, finalize its xref:authentication.adoc[configuration] by providing e.g. an SSH key.
10
+
11
+
If you do not want to use Ignition to get started, you can make use of the https://coreos.github.io/afterburn/platforms/[Afterburn support].
10
12
11
13
You also need to have access to an Alibaba Cloud account and https://www.alibabacloud.com/help/doc-detail/31884.htm?spm=a2c63.p38356.879954.10.3d1264baRYHfmB#task-njz-hf4-tdb[activated Object Storage Service (OSS)].
12
14
The examples below use the https://www.alibabacloud.com/help/product/29991.htm[Alibaba Cloud CLI] and https://stedolan.github.io/jq/[jq] as a command-line JSON processor.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/provisioning-aws.adoc
+47-1Lines changed: 47 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,10 +6,56 @@ This guide shows how to provision new Fedora CoreOS (FCOS) instances on the Amaz
6
6
7
7
Before provisioning an FCOS machine, you must have an Ignition configuration file containing your customizations. If you do not have one, see xref:producing-ign.adoc[Producing an Ignition File].
8
8
9
-
If you do not want to use Ignition to get started, you can make use of the https://coreos.github.io/afterburn/platforms/[Afterburn support] and provide an SSH key via the cloud provider and continue from there.
9
+
NOTE: Fedora CoreOS has a default `core` user that can be used to explore the OS. If you want to use it, finalize its xref:authentication.adoc[configuration] by providing e.g. an SSH key.
10
+
11
+
If you do not want to use Ignition to get started, you can make use of the https://coreos.github.io/afterburn/platforms/[Afterburn support].
10
12
11
13
You also need to have access to an AWS account. The examples below use the https://aws.amazon.com/cli/[aws] command-line tool, which must be separately installed and configured beforehand.
12
14
13
15
== Launching a VM instance
14
16
17
+
=== Minimal Example
18
+
15
19
include::getting-started-aws.adoc[]
20
+
21
+
=== Customized Example
22
+
23
+
In order to launch a customized FCOS instance, a valid Ignition configuration must be passed as its https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html#instancedata-add-user-data[user data] at creation time. You can use the same command from the xref:#_minimal_example[] but add `--user-data file://path/to/config.ign` argument:
24
+
25
+
NOTE: The SSH key for the `core` user is supplied via Afterburn in this example as well.
26
+
27
+
.Launching and customizing a new instance
28
+
[source,bash]
29
+
----
30
+
NAME='instance1'
31
+
SSHKEY='my-key' # the name of your SSH key: `aws ec2 describe-key-pairs`
32
+
IMAGE='ami-xxx' # the AMI ID found on the download page
33
+
DISK='20' # the size of the hard disk
34
+
REGION='us-east-1' # the target region
35
+
TYPE='m5.large' # the instance type
36
+
SUBNET='subnet-xxx' # the subnet: `aws ec2 describe-subnets`
37
+
SECURITY_GROUPS='sg-xx' # the security group `aws ec2 describe-security-groups`
38
+
USERDATA='/path/to/config.ign' # path to your Ignition config
NOTE: By design, cloud-init configuration and startup scripts are not supported on FCOS. Instead, it is recommended to encode any startup logic as systemd service units in the Ignition configuration.
52
+
53
+
TIP: You can find out the instance's assigned IP by running `aws ec2 describe-instances`
54
+
55
+
You now should be able to SSH into the instance using the associated IP address.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/provisioning-azure.adoc
+11-1Lines changed: 11 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,9 @@ This guide shows how to provision new Fedora CoreOS (FCOS) nodes on Azure. Fedor
6
6
7
7
Before provisioning an FCOS machine, you must have an Ignition configuration file containing your customizations. If you do not have one, see xref:producing-ign.adoc[Producing an Ignition File].
8
8
9
-
If you do not want to use Ignition to get started, you can make use of the https://coreos.github.io/afterburn/platforms/[Afterburn support] and provide an SSH key via the cloud provider and continue from there.
9
+
NOTE: Fedora CoreOS has a default `core` user that can be used to explore the OS. If you want to use it, finalize its xref:authentication.adoc[configuration] by providing e.g. an SSH key.
10
+
11
+
If you do not want to use Ignition to get started, you can make use of the https://coreos.github.io/afterburn/platforms/[Afterburn support].
10
12
11
13
You also need to have access to an Azure subscription. The examples below use the https://docs.microsoft.com/en-us/cli/azure/?view=azure-cli-latest[Azure CLI].
12
14
@@ -71,3 +73,11 @@ az_vm_name="my-fcos-vm"
71
73
ignition_path="./config.ign"
72
74
az vm create -n "${az_vm_name}" -g "${az_resource_group}" --image "${az_image_name}" --admin-username core --custom-data "$(cat ${ignition_path})"
73
75
----
76
+
77
+
. You now should be able to SSH into the instance using the associated IP address.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/provisioning-digitalocean.adoc
+12-2Lines changed: 12 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,9 @@ This guide shows how to provision new Fedora CoreOS (FCOS) nodes on DigitalOcean
6
6
7
7
Before provisioning an FCOS machine, you must have an Ignition configuration file containing your customizations. If you do not have one, see xref:producing-ign.adoc[Producing an Ignition File].
8
8
9
-
If you do not want to use Ignition to get started, you can make use of the https://coreos.github.io/afterburn/platforms/[Afterburn support] and provide an SSH key via the cloud provider and continue from there.
9
+
NOTE: Fedora CoreOS has a default `core` user that can be used to explore the OS. If you want to use it, finalize its xref:authentication.adoc[configuration] by providing e.g. an SSH key.
10
+
11
+
If you do not want to use Ignition to get started, you can make use of the https://coreos.github.io/afterburn/platforms/[Afterburn support].
10
12
11
13
You also need to have access to a DigitalOcean account. The examples below use the https://github.com/digitalocean/doctl[doctl] command-line tool.
While the DigitalOcean documentation mentions cloud-init and scripts, FCOS does not support cloud-init or the ability to run scripts from user-data. It accepts only Ignition configuration files.
53
+
NOTE: While the DigitalOcean documentation mentions `cloud-init` and scripts, FCOS does not support cloud-init or the ability to run scripts from user-data. It accepts only Ignition configuration files.
54
+
55
+
. You now should be able to SSH into the instance using the associated IP address.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/provisioning-exoscale.adoc
+12-2Lines changed: 12 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,9 @@ This guide shows how to provision new Fedora CoreOS (FCOS) instances on https://
6
6
7
7
Before provisioning an FCOS machine, it is recommended to have an Ignition configuration file containing your customizations. If you do not have one, see xref:producing-ign.adoc[Producing an Ignition File].
8
8
9
-
If you do not want to use Ignition to get started, you can make use of the https://coreos.github.io/afterburn/platforms/[Afterburn support] and provide an SSH key via the cloud provider and continue from there.
9
+
NOTE: Fedora CoreOS has a default `core` user that can be used to explore the OS. If you want to use it, finalize its xref:authentication.adoc[configuration] by providing e.g. an SSH key.
10
+
11
+
If you do not want to use Ignition to get started, you can make use of the https://coreos.github.io/afterburn/platforms/[Afterburn support]..
10
12
11
13
You also need to have access to an Exoscale account. https://portal.exoscale.com/register[Register] if you don't have one.
NOTE: If just SSH access is desired and no further customization is required, you don't need to pass any Ignition file and you can omit the `--cloud-init` argument.
76
78
77
-
Now you can find the IP address of the instance via `exo compute instance show $NAME` and SSH into the instance. If you didn’t change the defaults, the username is `core` and `ssh core@$IP` should work.
79
+
TIP: You can find out the instance's assigned IP by running `exo compute instance show $NAME`
80
+
81
+
You now should be able to SSH into the instance using the associated IP address.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/provisioning-gcp.adoc
+13-3Lines changed: 13 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,9 @@ This guide shows how to provision new Fedora CoreOS (FCOS) instances on Google C
6
6
7
7
Before provisioning an FCOS machine, you must have an Ignition configuration file containing your customizations. If you do not have one, see xref:producing-ign.adoc[Producing an Ignition File].
8
8
9
-
If you do not want to use Ignition to get started, you can make use of the https://coreos.github.io/afterburn/platforms/[Afterburn support] and provide an SSH key via the cloud provider and continue from there.
9
+
NOTE: Fedora CoreOS has a default `core` user that can be used to explore the OS. If you want to use it, finalize its xref:authentication.adoc[configuration] by providing e.g. an SSH key.
10
+
11
+
If you do not want to use Ignition to get started, you can make use of the https://coreos.github.io/afterburn/platforms/[Afterburn support].
10
12
11
13
You also need to have access to a GCP account. The examples below use the https://cloud.google.com/sdk/gcloud[gcloud] command-line tool, which must be separately installed and configured beforehand.
12
14
@@ -37,7 +39,7 @@ New GCP instances can be directly created and booted from public FCOS images.
37
39
38
40
If you just want SSH access and no further customization, you don't need to pass any custom instance metadata. Depending on your GCP project configuration, relevant SSH public keys will be automatically added to the VM. This provides an easy way to test out FCOS without first creating an Ignition config.
39
41
40
-
NOTE: Currently we don't support logging in using ssh through the GCP web console, using the `gcloud beta compute ssh` cli method or OS Login. See https://github.com/coreos/fedora-coreos-tracker/issues/648[fedora-coreos-tracker#648] for more information.
42
+
NOTE: Currently we don't support logging in using SSH through the GCP web console, using the `gcloud compute ssh` CLI method or OS Login. See https://github.com/coreos/fedora-coreos-tracker/issues/648[fedora-coreos-tracker#648] for more information.
Once the VM finished booting, you should be able to SSH into the instance using the IP address associated with the instance. If you didn’t change the defaults, the username is `core` and `ssh core@IP` should work.
52
+
TIP: You can find out the instance's assigned IP by running `gcloud compute instances list`
53
+
54
+
You now should be able to SSH into the instance using the associated IP address.
55
+
56
+
.Example connecting
57
+
[source, bash]
58
+
----
59
+
ssh core@<ip address>
60
+
----
51
61
52
62
In order to launch a customized FCOS instance, a valid Ignition configuration must be passed as user-data at creation time:
0 commit comments