github.com/Racer159/jackal@v0.32.7-0.20240401174413-0bd2339e4f2e/docs/5-jackal-tutorials/1-initializing-a-k8s-cluster.md (about)

     1  # Initializing a K8s Cluster
     2  
     3  ## Introduction
     4  
     5  In this tutorial, we will demonstrate how to initialize Jackal onto a K8s cluster. This is done by running the [`jackal init`](../2-the-jackal-cli/100-cli-commands/jackal_init.md) command, which uses a specialized package called an 'init-package'. More information about this specific package can be found [here](../3-create-a-jackal-package/3-jackal-init-package.md).
     6  
     7  ## Prerequisites
     8  
     9  Before beginning this tutorial you will need the following:
    10  
    11  - The [Jackal](https://github.com/Racer159/jackal) repository cloned: ([`git clone` Instructions](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository))
    12  - Jackal binary installed on your $PATH: ([Installing Jackal](../1-getting-started/index.md#installing-jackal))
    13  - An init-package downloaded: ([init-package Build Instructions](./0-creating-a-jackal-package.md)) or ([Download Location](https://github.com/Racer159/jackal/releases))
    14  - A Kubernetes cluster to work with: ([Local k8s Cluster Instructions](./#setting-up-a-local-kubernetes-cluster))
    15  
    16  ## Initializing the Cluster
    17  
    18  1. Run the `jackal init` command on your cluster.
    19  
    20  ```sh
    21  $ jackal init
    22  ```
    23  
    24  2. When prompted to deploy the package select `y` for Yes, then hit the `enter` key. <br/>
    25  
    26  3. Decline Optional Components
    27  
    28  :::info
    29  
    30  More information about the init-package and its components can be found [here](../3-create-a-jackal-package/3-jackal-init-package.md)
    31  
    32  :::
    33  
    34  <iframe src="/docs/tutorials/jackal_init.html" height="800px" width="100%"></iframe>
    35  
    36  :::note
    37  You will only be prompted to deploy the k3s component if you are on a Linux machine
    38  :::
    39  
    40  ### Validating the Deployment
    41  After the `jackal init` command is done running, you should see a few new `jackal` pods in the Kubernetes cluster.
    42  
    43  ```bash
    44  jackal tools monitor
    45  
    46  # Note you can press `0` if you want to see all namespaces and CTRL-C to exit
    47  ```
    48  ![Jackal Tools Monitor](../.images/tutorials/jackal_tools_monitor.png)
    49  
    50  ## Cleaning Up
    51  
    52  The [`jackal destroy`](../2-the-jackal-cli/100-cli-commands/jackal_destroy.md) command will remove all of the resources that were created by the initialization command. This command will leave you with a clean cluster that you can either destroy or use for another tutorial.
    53  
    54  ```sh
    55  jackal destroy --confirm
    56  ```