github.com/Racer159/jackal@v0.32.7-0.20240401174413-0bd2339e4f2e/docs/5-jackal-tutorials/index.md (about)

     1  # Jackal Tutorials
     2  
     3  This section of the documentation has a collection of tutorials that will help you get more familiar with Jackal and its features. The tutorials assume that you have a very basic understanding of what Jackal is and aims to help expand your working knowledge of how to use Jackal and what Jackal is capable of doing.
     4  
     5  ## Tutorial Prerequisites
     6  If a tutorial has any prerequisites, they will be listed at the beginning of the tutorial with instructions on how to fulfill them.
     7  Almost all tutorials will have the following prerequisites/assumptions:
     8  
     9  1. 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))
    10  1. You have a Jackal binary installed on your $PATH: ([Installing Jackal](../1-getting-started/index.md#installing-jackal))
    11  1. You have an init-package built/downloaded: ([init-package Build Instructions](./0-creating-a-jackal-package.md)) or ([Download Location](https://github.com/Racer159/jackal/releases))
    12  1. Have a kubernetes cluster running/available (ex. [k3s](https://k3s.io/)/[k3d](https://k3d.io/v5.4.1/)/[Kind](https://kind.sigs.k8s.io/docs/user/quick-start#installation))
    13  
    14  ## Setting Up a Local Kubernetes Cluster
    15  
    16  While Jackal is able to deploy a local k3s Kubernetes cluster for you, (as you'll find out more in the [Creating a K8s Cluster with Jackal](./5-creating-a-k8s-cluster-with-jackal.md) tutorial), that k3s cluster will only work if you are on a root user on a Linux machine. If you are on a Mac, or you're on Linux but don't have root access, you'll need to set up a local dockerized Kubernetes cluster manually. We provide instructions on how to quickly set up a local k3d cluster that you can use for the majority of the tutorials.
    17  
    18  ### Install k3d
    19  
    20  1. Install Docker: [Docker Install Instructions](https://docs.docker.com/get-docker/)
    21  2. Install k3d: [k3d Install Instructions](https://k3d.io/#installation)
    22  
    23  ### Start up k3d cluster
    24  
    25  ```bash
    26  k3d cluster create      # Creates a k3d cluster
    27                          # This will take a couple of minutes to complete
    28  
    29  
    30  jackal tools kubectl get pods -A    # Check to see if the cluster is ready
    31  ```
    32  
    33  ### Tear Down k3d CLuster
    34  
    35  ```bash
    36  k3d cluster delete      # Deletes the k3d cluster
    37  ```