Centralized install of Fox, expounded on Docker, Git and kind installs

xigxog · Jun 11, 2024 · a854bd4 · a854bd4
1 parent f843fa2
commit a854bd4
Show file tree

Hide file tree

Showing 5 changed files with 103 additions and 80 deletions.
diff --git a/docs/getting_started/.pages b/docs/getting_started/.pages
@@ -0,0 +1,5 @@
+nav:
+  - index.md
+  - quickstart.md
+  - tutorials
+  - fox-cli.md
diff --git a/docs/getting_started/fox-cli.md b/docs/getting_started/fox-cli.md
@@ -0,0 +1,28 @@
+# Install the Fox CLI
+
+The Fox CLI ("Fox") is a tool used to interact with KubeFox and prepare your Apps
+for deployment and release.
+
+=== "Install using Go"
+
+    ```{ .shell .copy }
+    go install github.com/xigxog/fox@latest
+    ```
+
+=== "Install using Bash"
+
+    ```{ .shell .copy }
+    curl -sL "https://github.com/xigxog/fox/releases/latest/download/fox-$(uname -s | tr 'A-Z' 'a-z')-amd64.tar.gz" | \
+      tar xvz - -C /tmp && \
+      sudo mv /tmp/fox /usr/local/bin/fox
+    ```
+
+=== "Install Manually"
+
+    Download the [latest Fox release](https://github.com/xigxog/fox/releases/latest){:target="_blank"} for your OS and extract the `fox` binary to a directory on your path.
+
+You can check the version of Fox with ```fox version```.
+
+If you were running the Quickstart, you can return to it by clicking **[here](./quickstart.md#prerequisites)**.
+
+If you were running the KubeFox and Hasura Tutorial, you can return to it by clicking **[here](./tutorials/graphql.md#prerequisites)**.
diff --git a/docs/getting_started/index.md b/docs/getting_started/index.md
@@ -2,3 +2,8 @@
 
 We're just beginning to build out the Getting Started section. The
 [Quickstart](./quickstart.md) is a good first stop.
+
+You can find installation instructions for the Fox CLI **[here](./fox-cli.md)**.
+
+The GitHub page for the Fox CLI is **[here](https://github.com/xigxog/kubefox-cli/releases/)**.
+
diff --git a/docs/getting_started/quickstart.md b/docs/getting_started/quickstart.md
@@ -10,32 +10,49 @@ KubeFox. Let's dive in!
 
 ## Prerequisites
 
-Ensure that the following tools are installed for this quickstart:
-
-- [Docker](https://docs.docker.com/engine/install/) - A container toolset and
-  runtime used to build KubeFox Components' OCI images and run a local
-  Kubernetes Cluster via kind.
-- [Fox](https://github.com/xigxog/kubefox-cli/releases/) - A CLI for
-  communicating with the KubeFox Platform. Installation instructions are below.
-- [Git](https://github.com/git-guides/install-git) - A distributed version
-  control system.
-- [Helm](https://helm.sh/docs/intro/install/) - Package manager for Kubernetes
+Ensure that the following tools are installed for this quickstart (each of the
+keywords below contains a link to the installation web page for the referenced product):
+
+- **[Docker Desktop](https://docs.docker.com/get-docker/)** - The easiest way to get
+  going with Docker is to install Docker Desktop.  Docker is a container toolset and
+  runtime used to build KubeFox Component OCI images and run a local
+  Kubernetes Cluster via kind.  Click the link corresponding to the OS you wish
+  you use.
+    - **[MacOS](https://docs.docker.com/desktop/install/mac-install)** - Install
+      Docker Desktop on Mac.
+    - **[Windows](https://docs.docker.com/desktop/install/windows-install)** -
+      Install Docker Desktop on Windows.
+    - **[Linux](https://docs.docker.com/desktop/install/linux-install/)** - Install
+      Docker Desktop on Linux.
+- **[Fox](./fox-cli.md)** - A CLI for
+  communicating with the KubeFox Platform.
+- **[Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)** - A distributed version
+  control system.  If this is the first time you're installing git, go through
+  the steps to ensure that your identity is established (see "Your Identity" on the next
+  **[page](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup)**).
+- **[Helm](https://helm.sh/docs/intro/install/)** - Package manager for Kubernetes
   used to install the KubeFox Operator on Kubernetes.
-- [Kind](https://kind.sigs.k8s.io/docs/user/quick-start/) - **K**uberentes
-  **in** **D**ocker. A tool for running local Kubernetes Clusters using Docker
-  container "nodes".
-- [Kubectl](https://kubernetes.io/docs/tasks/tools/) - CLI for communicating
+- **[kind](https://kind.sigs.k8s.io/docs/user/quick-start/)** - kind is **K**uberentes
+  **in** **D**ocker. kind is a tool for running local Kubernetes Clusters using Docker
+  container "nodes", hence Docker must be running before you use kind to create
+  your Kubernetes cluster. 
+- **[Kubectl](https://kubernetes.io/docs/tasks/tools/)** - CLI for communicating
   with a Kubernetes Cluster's control plane, using the Kubernetes API.
 
 Here are a few optional but recommended tools:
 
-- [Go](https://go.dev/doc/install) - A programming language. The `hello-world`
+- **[Go](https://go.dev/doc/install)** - A programming language. The `hello-world`
   example App is written in Go, but Fox is able to compile it even without Go
   installed.
-- [VS Code](https://code.visualstudio.com/download) - A lightweight but powerful
+- **[VS Code](https://code.visualstudio.com/download)** - A lightweight but powerful
   source code editor. Helpful if you want to explore the `hello-world` app.
-- [Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli) -
+- **[Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli)** -
   CLI for communicating with the Azure control plane.
+- **[k9s](https://k9scli.io/topics/install/)** - A terminal based UI to interact
+  with your Kubernetes clusters. You can use native kubectl commands to
+  accomplish the same things, but k9s is a nice convenience and we use it here.
+  By the way, the k9s **[homepage](https://k9scli.io/)** is probably the cleverest of any
+  company in the k8s space, succeeding in that endeavor at many levels.
 
 ## Tracing
 
@@ -238,27 +255,6 @@ Apps.
         REVISION: 1
         ```
 
-Now install Fox, a CLI tool used to interact with KubeFox and prepare your Apps
-for deployment and release.
-
-=== "Install using Go"
-
-    ```{ .shell .copy }
-    go install github.com/xigxog/fox@latest
-    ```
-
-=== "Install using Bash"
-
-    ```{ .shell .copy }
-    curl -sL "https://github.com/xigxog/fox/releases/latest/download/fox-$(uname -s | tr 'A-Z' 'a-z')-amd64.tar.gz" | \
-      tar xvz - -C /tmp && \
-      sudo mv /tmp/fox /usr/local/bin/fox
-    ```
-
-=== "Install Manually"
-
-    Download the [latest Fox release](https://github.com/xigxog/fox/releases/latest){:target="_blank"} for your OS and extract the `fox` binary to a directory on your path.
-
 ## Deploy
 
 Awesome! You're all set to start the KubeFox Platform on the your newly created

diff --git a/docs/getting_started/tutorials/graphql.md b/docs/getting_started/tutorials/graphql.md
@@ -22,36 +22,48 @@ Issues](https://github.com/xigxog/kubefox/issues).
 
 ## Prerequisites
 
-Ensure that the following tools are installed for this tutorial:
-
-- [Docker](https://docs.docker.com/engine/install/) - A container toolset and
-  runtime used to build KubeFox Components' OCI images and run a local
-  Kubernetes Cluster via kind.
-- [Fox](https://github.com/xigxog/kubefox-cli/releases/) - A CLI for
-  communicating with the KubeFox Platform. Installation instructions are below.
-- [Git](https://github.com/git-guides/install-git) - A distributed version
-  control system.
-- [Helm](https://helm.sh/docs/intro/install/) - Package manager for Kubernetes
+Ensure that the following tools are installed for this quickstart (each of the
+keywords below contains a link to the installation web page for the referenced product):
+
+- **[Docker Desktop](https://docs.docker.com/get-docker/)** - The easiest way to get
+  going with Docker is to install Docker Desktop.  Docker is a container toolset and
+  runtime used to build KubeFox Component OCI images and run a local
+  Kubernetes Cluster via kind.  Click the link corresponding to the OS you wish
+  you use.
+    - **[MacOS](https://docs.docker.com/desktop/install/mac-install)** - Install
+      Docker Desktop on Mac.
+    - **[Windows](https://docs.docker.com/desktop/install/windows-install)** -
+      Install Docker Desktop on Windows.
+    - **[Linux](https://docs.docker.com/desktop/install/linux-install/)** - Install
+      Docker Desktop on Linux.
+- **[Fox](../fox-cli.md)** - A CLI for
+  communicating with the KubeFox Platform.
+- **[Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)** - A distributed version
+  control system.  If this is the first time you're installing git, go through
+  the steps to ensure that your identity is established (see "Your Identity" on the next
+  **[page](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup)**).
+- **[Helm](https://helm.sh/docs/intro/install/)** - Package manager for Kubernetes
   used to install the KubeFox Operator on Kubernetes.
-- [Kind](https://kind.sigs.k8s.io/docs/user/quick-start/) - **K**uberentes
-  **in** **D**ocker. A tool for running local Kubernetes Clusters using Docker
-  container "nodes".
-- [Kubectl](https://kubernetes.io/docs/tasks/tools/) - CLI for communicating
+- **[kind](https://kind.sigs.k8s.io/docs/user/quick-start/)** - kind is **K**uberentes
+  **in** **D**ocker. kind is a tool for running local Kubernetes Clusters using Docker
+  container "nodes", hence Docker must be running before you use kind to create
+  your Kubernetes cluster. 
+- **[Kubectl](https://kubernetes.io/docs/tasks/tools/)** - CLI for communicating
   with a Kubernetes Cluster's control plane, using the Kubernetes API.
-- [k9s](https://k9scli.io/topics/install/) - A terminal based UI to interact
+- **[k9s](https://k9scli.io/topics/install/)** - A terminal based UI to interact
   with your Kubernetes clusters. You can use native kubectl commands to
   accomplish the same things, but k9s is a nice convenience and we use it here.
-  By the way, the k9s [homepage](https://k9scli.io/) is probably the cleverest of any
+  By the way, the k9s **[homepage](https://k9scli.io/)** is probably the cleverest of any
   company in the k8s space, succeeding in that endeavor at many levels.
 
 Here are a few optional but recommended tools:
 
-- [Go](https://go.dev/doc/install) - A programming language. The `hello-world`
+- **[Go](https://go.dev/doc/install)** - A programming language. The `hello-world`
   example App is written in Go, but Fox is able to compile it even without Go
   installed.
-- [VS Code](https://code.visualstudio.com/download) - A lightweight but powerful
+- **[VS Code](https://code.visualstudio.com/download)** - A lightweight but powerful
   source code editor. Helpful if you want to explore the `hello-world` app.
-- [Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli) -
+- **[Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli)** -
   CLI for communicating with the Azure control plane.
 
 ## Setup Kubernetes
@@ -284,29 +296,6 @@ helm upgrade kubefox kubefox \
     TEST SUITE: None
     ```
 
-## Get the Fox CLI
-
-Now install Fox, a CLI tool used to interact with KubeFox and prepare your Apps
-for deployment and release.
-
-=== "Install using Go"
-
-    ```{ .shell .copy }
-    go install github.com/xigxog/fox@latest
-    ```
-
-=== "Install using Bash"
-
-    ```{ .shell .copy }
-    curl -sL "https://github.com/xigxog/fox/releases/latest/download/fox-$(uname -s | tr 'A-Z' 'a-z')-amd64.tar.gz" | \
-      tar xvz - -C /tmp && \
-      sudo mv /tmp/fox /usr/local/bin/fox
-    ```
-
-=== "Install Manually"
-
-    Download the [latest Fox release](https://github.com/xigxog/fox/releases/latest){:target="_blank"} for your OS and extract the `Fox` binary to a directory on your path.
-
 ## Set up the Tutorial
 
 Awesome! You're all set to start the KubeFox Platform on the your newly created