From 18697feab028887e0dd0dfd668690dfc34fb1861 Mon Sep 17 00:00:00 2001 From: Kaelyn Date: Thu, 21 Sep 2023 15:32:02 -0700 Subject: [PATCH 1/5] Add env descriptions to docs --- reference/runtime-environment.html.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/reference/runtime-environment.html.md b/reference/runtime-environment.html.md index 6afe61bfaf..54535f9ef9 100644 --- a/reference/runtime-environment.html.md +++ b/reference/runtime-environment.html.md @@ -32,6 +32,21 @@ Not to be confused with the [HTTP header](/docs/reference/runtime-environment/#f ### `FLY_IMAGE_REF` **Docker Image Reference**: The name of the Docker image running this container. Useful if your application needs to launch Machine instances of itself to scale up-or-down. Read about how [a Rails app runs Machines for scale-to-zero background workers](https://fly.io/ruby-dispatch/rails-background-jobs-with-fly-machines/). `registry.fly.io/my-app-name:deployment-01H9RK9EYO9PGNBYAKGXSHV0PH` is an example of the Docker Image Reference's format. +### `FLY_MACHINE_ID` +**Machine ID**: Each Fly Machine is identified by a unique Machine ID. This is the ID that `flyctl` and the `Machines API` use to identify that Machine, and you'll see it in the [logs](/docs/flyctl/logs/). + +### `FLY_MACHINE_VERSION` +**Machine configuration version**: Every Machine configuration has an associated version. Whenever you update a Machine's configuration (including when you update its Docker image), it gets a new `FLY_MACHINE_VERSION`. The exception to this is that changing only the Machine's metadata doesn't trigger a new version. + +### `FLY_PRIVATE_IP` +**Private IPv6 address**: This is the `IPv6 address` of the Machine on its [6PN private network](/docs/reference/private-networking/). + +### `FLY_PROCESS_GROUP` +**Process group**: This is [the process group](/docs/apps/processes) associated with the machine. + +### `FLY_VM_MEMORY_MB` +**Machine memory**: This is the memory allocated to the Machine, in MBs. It's the same value you'll find under https://fly.io/dashboard/personal/machines and VM Memory in the output of `fly machine status`. More information on sizing [here](/docs/machines/guides-examples/machine-sizing/)! + ## _Request Headers_ ### `Fly-Client-IP` From 1b4059ed67e113deb051d05ddc4b2075e953b865 Mon Sep 17 00:00:00 2001 From: Kaelyn Date: Thu, 21 Sep 2023 15:34:17 -0700 Subject: [PATCH 2/5] Made text stlying change --- reference/runtime-environment.html.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/reference/runtime-environment.html.md b/reference/runtime-environment.html.md index 54535f9ef9..00cd7cf89c 100644 --- a/reference/runtime-environment.html.md +++ b/reference/runtime-environment.html.md @@ -36,16 +36,16 @@ Not to be confused with the [HTTP header](/docs/reference/runtime-environment/#f **Machine ID**: Each Fly Machine is identified by a unique Machine ID. This is the ID that `flyctl` and the `Machines API` use to identify that Machine, and you'll see it in the [logs](/docs/flyctl/logs/). ### `FLY_MACHINE_VERSION` -**Machine configuration version**: Every Machine configuration has an associated version. Whenever you update a Machine's configuration (including when you update its Docker image), it gets a new `FLY_MACHINE_VERSION`. The exception to this is that changing only the Machine's metadata doesn't trigger a new version. +**Machine Configuration Version**: Every Machine configuration has an associated version. Whenever you update a Machine's configuration (including when you update its Docker image), it gets a new `FLY_MACHINE_VERSION`. The exception to this is that changing only the Machine's metadata doesn't trigger a new version. ### `FLY_PRIVATE_IP` -**Private IPv6 address**: This is the `IPv6 address` of the Machine on its [6PN private network](/docs/reference/private-networking/). +**Private IPv6 Address**: This is the `IPv6 address` of the Machine on its [6PN private network](/docs/reference/private-networking/). ### `FLY_PROCESS_GROUP` -**Process group**: This is [the process group](/docs/apps/processes) associated with the machine. +**Process Group**: This is [the process group](/docs/apps/processes) associated with the machine. ### `FLY_VM_MEMORY_MB` -**Machine memory**: This is the memory allocated to the Machine, in MBs. It's the same value you'll find under https://fly.io/dashboard/personal/machines and VM Memory in the output of `fly machine status`. More information on sizing [here](/docs/machines/guides-examples/machine-sizing/)! +**Machine Memory**: This is the memory allocated to the Machine, in MBs. It's the same value you'll find under https://fly.io/dashboard/personal/machines and VM Memory in the output of `fly machine status`. More information on sizing [here](/docs/machines/guides-examples/machine-sizing/)! ## _Request Headers_ From 0575efab8c2806d10470090b16602645c694bfa9 Mon Sep 17 00:00:00 2001 From: Kaelyn Date: Thu, 21 Sep 2023 15:36:45 -0700 Subject: [PATCH 3/5] small change on a word --- reference/runtime-environment.html.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/runtime-environment.html.md b/reference/runtime-environment.html.md index 00cd7cf89c..59e02e2966 100644 --- a/reference/runtime-environment.html.md +++ b/reference/runtime-environment.html.md @@ -42,7 +42,7 @@ Not to be confused with the [HTTP header](/docs/reference/runtime-environment/#f **Private IPv6 Address**: This is the `IPv6 address` of the Machine on its [6PN private network](/docs/reference/private-networking/). ### `FLY_PROCESS_GROUP` -**Process Group**: This is [the process group](/docs/apps/processes) associated with the machine. +**Process Group**: This is [the process group](/docs/apps/processes) associated with the Machine. ### `FLY_VM_MEMORY_MB` **Machine Memory**: This is the memory allocated to the Machine, in MBs. It's the same value you'll find under https://fly.io/dashboard/personal/machines and VM Memory in the output of `fly machine status`. More information on sizing [here](/docs/machines/guides-examples/machine-sizing/)! From 7b1d405077ae4a15adde3e80a07bc2c738448f03 Mon Sep 17 00:00:00 2001 From: Kaelyn Date: Fri, 22 Sep 2023 11:49:06 -0700 Subject: [PATCH 4/5] Updated the docs based on what was suggested --- reference/runtime-environment.html.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/reference/runtime-environment.html.md b/reference/runtime-environment.html.md index 59e02e2966..767ba34311 100644 --- a/reference/runtime-environment.html.md +++ b/reference/runtime-environment.html.md @@ -33,19 +33,19 @@ Not to be confused with the [HTTP header](/docs/reference/runtime-environment/#f **Docker Image Reference**: The name of the Docker image running this container. Useful if your application needs to launch Machine instances of itself to scale up-or-down. Read about how [a Rails app runs Machines for scale-to-zero background workers](https://fly.io/ruby-dispatch/rails-background-jobs-with-fly-machines/). `registry.fly.io/my-app-name:deployment-01H9RK9EYO9PGNBYAKGXSHV0PH` is an example of the Docker Image Reference's format. ### `FLY_MACHINE_ID` -**Machine ID**: Each Fly Machine is identified by a unique Machine ID. This is the ID that `flyctl` and the `Machines API` use to identify that Machine, and you'll see it in the [logs](/docs/flyctl/logs/). +**Machine ID**: The unique ID that flyctl commands and the Machines API use to identify a Machine. You can find it in the [logs](/docs/flyctl/logs/). ### `FLY_MACHINE_VERSION` -**Machine Configuration Version**: Every Machine configuration has an associated version. Whenever you update a Machine's configuration (including when you update its Docker image), it gets a new `FLY_MACHINE_VERSION`. The exception to this is that changing only the Machine's metadata doesn't trigger a new version. +**Machine Configuration Version**: The version associated to a specific Machine configuration. When you update a Machine's configuration (including when you update its Docker image), it gets a new `FLY_MACHINE_VERSION`. You can see this change by running `fly machine status`. Changing the Machine's metadata however doesn't trigger a new version. ### `FLY_PRIVATE_IP` -**Private IPv6 Address**: This is the `IPv6 address` of the Machine on its [6PN private network](/docs/reference/private-networking/). +**Private IPv6 Address**: The IPv6 address of the Machine on its [6PN private network](/docs/reference/private-networking/). ### `FLY_PROCESS_GROUP` -**Process Group**: This is [the process group](/docs/apps/processes) associated with the Machine. +**Process Group**: The [process group](/docs/apps/processes) associated with the Machine. ### `FLY_VM_MEMORY_MB` -**Machine Memory**: This is the memory allocated to the Machine, in MBs. It's the same value you'll find under https://fly.io/dashboard/personal/machines and VM Memory in the output of `fly machine status`. More information on sizing [here](/docs/machines/guides-examples/machine-sizing/)! +**Machine Memory**: The memory allocated to the Machine, in MB. It's the same value you'll find under https://fly.io/dashboard/personal/machines and VM Memory in the output of `fly machine status`. Learn more about [Machine sizing](/docs/machines/guides-examples/machine-sizing/). ## _Request Headers_ From 30c52c8f63d4429d65af0e3b22c21c9a9eb86a6c Mon Sep 17 00:00:00 2001 From: Kaelyn <87516931+Lucais11@users.noreply.github.com> Date: Fri, 22 Sep 2023 12:59:19 -0700 Subject: [PATCH 5/5] Update reference/runtime-environment.html.md Co-authored-by: catflydotio <95245363+catflydotio@users.noreply.github.com> --- reference/runtime-environment.html.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/runtime-environment.html.md b/reference/runtime-environment.html.md index 767ba34311..e836b4b322 100644 --- a/reference/runtime-environment.html.md +++ b/reference/runtime-environment.html.md @@ -36,7 +36,7 @@ Not to be confused with the [HTTP header](/docs/reference/runtime-environment/#f **Machine ID**: The unique ID that flyctl commands and the Machines API use to identify a Machine. You can find it in the [logs](/docs/flyctl/logs/). ### `FLY_MACHINE_VERSION` -**Machine Configuration Version**: The version associated to a specific Machine configuration. When you update a Machine's configuration (including when you update its Docker image), it gets a new `FLY_MACHINE_VERSION`. You can see this change by running `fly machine status`. Changing the Machine's metadata however doesn't trigger a new version. +**Machine Configuration Version**: The version associated to a specific Machine configuration. When you update a Machine's configuration (including when you update its Docker image), it gets a new `FLY_MACHINE_VERSION`. You can also find this value under the name `Instance ID` in the output of `fly machine status`. Changing the Machine's metadata however doesn't trigger a new version. ### `FLY_PRIVATE_IP` **Private IPv6 Address**: The IPv6 address of the Machine on its [6PN private network](/docs/reference/private-networking/).