github.com/Racer159/jackal@v0.32.7-0.20240401174413-0bd2339e4f2e/docs/1-getting-started/index.md (about)

     1  import TabItem from "@theme/TabItem";
     2  import Tabs from "@theme/Tabs";
     3  
     4  # Getting Started
     5  
     6  Welcome to the Jackal documentation!  This page runs through a quick start to test Jackal on your machine and walks through next steps to get more familiar with Jackal's concepts. Let's get started!
     7  
     8  ## Quick Start
     9  
    10  Trying out Jackal is as simple as:
    11  
    12  1. 💻 Selecting your system's OS below.
    13  2. ❗ Ensuring you have the pre-requisite applications running.
    14  3. `$` Entering the commands into your terminal.
    15  
    16  <Tabs>
    17  <TabItem value="macOS">
    18  
    19  :::note
    20  
    21  This quick start requires you to already have:
    22  
    23  - [Homebrew](https://brew.sh/) package manager installed on your machine.
    24  - [Docker](https://www.docker.com/) installed and running on your machine.
    25  
    26  For more install options please visit our [Installing Jackal page](./0-installing-jackal.md).
    27  
    28  :::
    29  
    30  ## macOS Commands
    31  
    32  ```bash
    33  # To install Jackal with Homebrew simply run:
    34  brew tap defenseunicorns/tap && brew install jackal
    35  
    36  # Next, you will need a Kubernetes cluster. This example uses KIND.
    37  brew install kind && kind delete cluster && kind create cluster
    38  
    39  # Then, you need to initialize the cluster with Jackal:
    40  jackal init
    41  # (Select 'Y' to download the default init package)
    42  # (Select 'Y' to confirm deployment)
    43  # (Select optional components as desired)
    44  
    45  # Now you are ready to deploy any Jackal Package, try out our Retro Arcade!!
    46  jackal package deploy oci://🦄/dos-games:1.0.0-$(uname -m) --key=https://jackal.dev/cosign.pub
    47  # (Select 'Y' to confirm deployment)
    48  ```
    49  
    50  </TabItem>
    51  <TabItem value="Linux">
    52  
    53  :::note
    54  
    55  This quick start requires you to already have:
    56  
    57  - [Homebrew](https://brew.sh/) package manager installed on your machine.
    58  - [Docker](https://www.docker.com/) installed and running on your machine.
    59  
    60  For more install options please visit our [Installing Jackal page](./0-installing-jackal.md).
    61  
    62  :::
    63  
    64  ## Linux Commands
    65  
    66  ```bash
    67  # To install Jackal with Homebrew simply run:
    68  brew tap defenseunicorns/tap && brew install jackal
    69  
    70  # Next, you will need a Kubernetes cluster. This example uses KinD.
    71  brew install kind && kind delete cluster && kind create cluster
    72  # (Note: you don't need 'KinD' if you have 'root' access since Jackal includes 'k3s' as an optional component)
    73  
    74  # Then, you need to initialize the cluster, following the prompts to download and select components
    75  jackal init
    76  # (Select 'Y' to download the default init package)
    77  # (Select 'Y' to confirm deployment)
    78  # (Select 'N' for 'k3s' - this only works when run as 'root')
    79  # (Select other optional components as desired)
    80  
    81  # Now you are ready to deploy any Jackal Package, try out our Retro Arcade!!
    82  jackal package deploy oci://🦄/dos-games:1.0.0-$(uname -m) --key=https://jackal.dev/cosign.pub
    83  # (Select 'Y' to confirm deployment)
    84  ```
    85  
    86  :::tip
    87  
    88  This example shows how to install Jackal with the official (📜) `defenseunicorns` Homebrew tap, however there are many other options to install Jackal on Linux such as:
    89  
    90  - 📜 **[official]** Downloading Jackal directly from [GitHub releases](https://github.com/Racer159/jackal/releases)
    91  - 🧑‍🤝‍🧑 **[community]** `apk add` on [Alpine Linux Edge](https://pkgs.alpinelinux.org/package/edge/testing/x86_64/jackal)
    92  - 🧑‍🤝‍🧑 **[community]** `asdf install` with the [ASDF Version Manager](https://github.com/defenseunicorns/asdf-jackal)
    93  - 🧑‍🤝‍🧑 **[community]** `nix-shell`/`nix-env` with [Nix Packages](https://search.nixos.org/packages?channel=23.05&show=jackal&from=0&size=50&sort=relevance&type=packages&query=jackal)
    94  
    95  :::
    96  
    97  </TabItem>
    98  <TabItem value="Windows">
    99  
   100  ## Windows Commands
   101  
   102  :::note
   103  
   104  There is currently no Jackal quick start for Windows, though you can learn how to install Jackal from our Github Releases by visiting the [Installing Jackal page](./0-installing-jackal.md#downloading-the-cli-from-github-releases).
   105  
   106  :::
   107  
   108  ```text
   109  
   110  Coming soon!
   111  
   112  ```
   113  
   114  </TabItem>
   115  </Tabs>
   116  
   117  ## Where to Next?
   118  
   119  Depending on how familiar you are with Kubernetes, DevOps, and Jackal, let's find what set of information would be most useful to you.
   120  
   121  - If you want to become more familiar with Jackal and it's features, see the [Tutorials](../5-jackal-tutorials/index.md) page.
   122  
   123  - More information about the Jackal CLI is available on the [Jackal CLI](../2-the-jackal-cli/index.md) page, or by browsing through the help descriptions of all the commands available through `jackal --help`.
   124  
   125  - More information about the packages that Jackal creates and deploys is available in the [Understanding Jackal Packages](../3-create-a-jackal-package/1-jackal-packages.md) page.
   126  
   127  - If you want to take a step back and better understand the problem Jackal is trying to solve, you can find more context on the [Understand the Basics](./1-understand-the-basics.md) and [Core Concepts](./2-core-concepts.md) pages.