### Download deployKF Sample Values File using curl

Source: https://www.deploykf.org/guides/getting-started

Downloads the sample-values.yaml file for a specific version of deployKF using the curl command. This file serves as a starting point for custom configurations. It specifies the output file name and the URL of the raw file from GitHub.

```shell
# download the `sample-values.yaml` file
curl -fL -o "sample-values-0.1.5.yaml" \
  "https://raw.githubusercontent.com/deployKF/deployKF/v0.1.5/sample-values.yaml"
```

--------------------------------

### Run deployKF Sync Script (Bash)

Source: https://www.deploykf.org/guides/getting-started

Executes the automated script for syncing ArgoCD applications. This script can take significant time on initial setup and is resilient to interruptions, allowing safe re-runs. Configuration variables at the script's top allow for customization.

```bash
bash ./sync_argocd_apps.sh
```

--------------------------------

### Install deployKF CLI on Linux

Source: https://www.deploykf.org/guides/deploykf-cli

Downloads and installs the deployKF CLI for Linux. This script fetches the binary, places it in /usr/local/bin, and makes it executable. It automatically detects and handles different architectures (amd64/arm64). After installation, you can verify it using 'deploykf version'.

```bash
DKF_CLI_VERSION="0.1.2"
DKF_CLI_ARCH=$(uname -m | sed -e 's/x86_64/amd64/' -e 's/aarch64/arm64/')
DFK_CLI_DEST=/usr/local/bin/deploykf

# download the binary
sudo curl -fL "https://github.com/deploykf/cli/releases/download/v${DKF_CLI_VERSION}/deploykf-linux-${DKF_CLI_ARCH}" -o "${DFK_CLI_DEST}"

# make the binary executable
sudo chmod +x "${DFK_CLI_DEST}"

# test the binary
deploykf version

```

--------------------------------

### Install Homebrew for Linux

Source: https://www.deploykf.org/guides/local-quickstart

Installs Homebrew, a package manager for Linux, macOS, and Windows. It uses curl to download and execute the installation script from GitHub.

```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```

--------------------------------

### Install ArgoCD and DeployKF Plugin

Source: https://www.deploykf.org/guides/local-quickstart

Clones the DeployKF repository, makes the ArgoCD installation script executable, and then runs the script to install ArgoCD and the DeployKF ArgoCD Plugin into the current kubectl context. This process sets up ArgoCD for managing DeployKF applications.

```bash
# clone the deploykf repo
# NOTE: we use 'main', as the latest plugin version always lives there
git clone -b main https://github.com/deployKF/deployKF.git ./deploykf

# ensure the script is executable
chmod +x ./deploykf/argocd-plugin/install_argocd.sh

# run the install script
# WARNING: this will install into your current kubectl context
bash ./deploykf/argocd-plugin/install_argocd.sh

```

--------------------------------

### Install deployKF CLI on macOS

Source: https://www.deploykf.org/guides/deploykf-cli

Downloads and installs the deployKF CLI for macOS. This script fetches the binary, places it in /usr/local/bin, and makes it executable. It handles different architectures (amd64/arm64). After installation, you can test it with 'deploykf version'. macOS security settings might require manual intervention.

```bash
DKF_CLI_VERSION="0.1.2"
DKF_CLI_ARCH=$(uname -m | sed -e 's/x86_64/amd64/')
DFK_CLI_DEST=/usr/local/bin/deploykf

# download the binary
sudo curl -fL "https://github.com/deploykf/cli/releases/download/v${DKF_CLI_VERSION}/deploykf-darwin-${DKF_CLI_ARCH}" -o "${DFK_CLI_DEST}"

# make the binary executable
sudo chmod +x "${DFK_CLI_DEST}"

# test the binary
deploykf version

```

--------------------------------

### Install Kubectx and Fzf

Source: https://www.deploykf.org/guides/local-quickstart

Installs kubectx and optionally fzf for managing kubectl contexts interactively. Kubectx simplifies switching between Kubernetes clusters, and fzf provides fuzzy-finder capabilities for a better user experience.

```bash
# NOTE: the installing the 'fzf' package is optional,
#       it will make 'kubectx' interactive
brew install kubectx fzf

```

--------------------------------

### Download and Execute ArgoCD Sync Script

Source: https://www.deploykf.org/guides/getting-started

Downloads the `sync_argocd_apps.sh` script, makes it executable, and runs it to synchronize ArgoCD applications in the correct order. This is the recommended method for syncing deployKF applications.

```bash
# download the latest version of the script
curl -fL -o "sync_argocd_apps.sh" \
  "https://raw.githubusercontent.com/deployKF/deployKF/main/scripts/sync_argocd_apps.sh"

# ensure the script is executable
chmod +x ./sync_argocd_apps.sh

# ensure your kubectl context is set correctly
kubectl config current-context

# To run the script (example):
# ./sync_argocd_apps.sh
```

--------------------------------

### Install deployKF CLI on Windows

Source: https://www.deploykf.org/guides/deploykf-cli

Downloads and installs the deployKF CLI for Windows using PowerShell. This script fetches the Windows amd64 binary and saves it to C:\\Windows\\System32. You need to run this in an elevated PowerShell prompt. After installation, you can test it with 'deploykf version'. Windows security features might require manual approval.

```powershell
$DKF_CLI_VERSION="0.1.2"
$DFK_CLI_DEST="C:\\Windows\\System32\\deploykf.exe"

# download the binary
Invoke-WebRequest -Uri "https://github.com/deploykf/cli/releases/download/v${DKF_CLI_VERSION}/deploykf-windows-amd64.exe" -OutFile "${DFK_CLI_DEST}"

# test the binary
deploykf version

```

--------------------------------

### Create MySQL Databases and User for DeployKF

Source: https://www.deploykf.org/guides/external/mysql

Example SQL commands to create the necessary databases (schemas) for Katib and Kubeflow Pipelines, along with a dedicated user ('kubeflow') with administrative privileges. It specifically sets the user's authentication plugin to `mysql_native_password` to ensure compatibility with Kubeflow Pipelines.

```sql
-- create the databases
CREATE DATABASE IF NOT EXISTS `katib`;
CREATE DATABASE IF NOT EXISTS `kfp_cache`;
CREATE DATABASE IF NOT EXISTS `kfp_metadata`;
CREATE DATABASE IF NOT EXISTS `kfp_pipelines`;

-- create the 'kubeflow' user (allowing access from any host)
CREATE USER 'kubeflow'@'%' IDENTIFIED WITH mysql_native_password BY 'MY_PASSWORD';

-- grant access to the databases
GRANT ALL PRIVILEGES ON `katib`.* TO 'kubeflow'@'%';
GRANT ALL PRIVILEGES ON `kfp_cache`.* TO 'kubeflow'@'%';
GRANT ALL PRIVILEGES ON `kfp_metadata`.* TO 'kubeflow'@'%';
GRANT ALL PRIVILEGES ON `kfp_pipelines`.* TO 'kubeflow'@'%';
```

--------------------------------

### Install Homebrew Dependencies

Source: https://www.deploykf.org/guides/local-quickstart

Installs essential tools such as Argo CD, jq, k3d, and kubectl using the Homebrew package manager. These are required for deploying and managing Kubernetes resources with DeployKF.

```bash
brew install argocd jq k3d kubectl
```

--------------------------------

### Generate Kubernetes Manifests with deployKF CLI

Source: https://www.deploykf.org/guides/deploykf-cli

Generates GitOps-ready Kubernetes manifests using the deployKF CLI. It takes a source version and a values file as input and outputs the manifests to a specified directory. Ensure the deployKF CLI is installed and accessible in your PATH.

```bash
deploykf generate \
  --source-version "0.1.5" \
  --values ./custom-values.yaml \
  --output-dir ./GENERATOR_OUTPUT
```

--------------------------------

### Load Istio Kernel Modules Immediately

Source: https://www.deploykf.org/guides/troubleshooting

These commands load specific kernel modules required by Istio immediately without requiring a reboot. They also help verify if any modules are missing.

```bash
sudo modprobe br_netfilter
sudo modprobe ip_tables
sudo modprobe iptable_filter
sudo modprobe iptable_mangle
sudo modprobe iptable_nat
sudo modprobe iptable_raw
sudo modprobe nf_nat
sudo modprobe x_tables
sudo modprobe xt_REDIRECT
sudo modprobe xt_conntrack
sudo modprobe xt_multiport
sudo modprobe xt_owner
sudo modprobe xt_tcpudp
```

--------------------------------

### Download Generator Package with cURL

Source: https://www.deploykf.org/guides/platform/offline

This command downloads a specific version of the deployKF generator package from GitHub releases using cURL. Ensure you have cURL installed and replace the version number with the desired one.

```bash
curl -fL -o "deploykf-0.1.5-generator.zip" \
  "https://github.com/deployKF/deployKF/releases/download/v0.1.5/deploykf-0.1.5-generator.zip"
```

--------------------------------

### Install k9s CLI

Source: https://www.deploykf.org/guides/local-quickstart

This command installs the k9s CLI tool, a powerful text-based UI for managing Kubernetes clusters. It can be installed using Homebrew on macOS and Linux systems. k9s simplifies pod status checking and cluster interaction.

```bash
brew install k9s
```

--------------------------------

### Load Istio Kernel Modules

Source: https://www.deploykf.org/guides/getting-started

Loads required kernel modules for Istio on Linux nodes. This includes configuring modules to load on boot and manually loading them using modprobe. Essential for Istio sidecar functionality and network stability.

```shell
lsmod | awk '{print $1}' | sort

```

```shell
cat <<EOF | sudo tee /etc/modules-load.d/99-istio-modules.conf
br_netfilter
ip_tables
iptable_filter
iptable_mangle
iptable_nat
iptable_raw
nf_nat
x_tables
xt_REDIRECT
xt_conntrack
xt_multiport
xt_owner
xt_tcpudp
EOF

```

```shell
sudo modprobe br_netfilter
sudo modprobe ip_tables
sudo modprobe iptable_filter
sudo modprobe iptable_mangle
sudo modprobe iptable_nat
sudo modprobe iptable_raw
sudo modprobe nf_nat
sudo modprobe x_tables
sudo modprobe xt_REDIRECT
sudo modprobe xt_conntrack
sudo modprobe xt_multiport
sudo modprobe xt_owner
sudo modprobe xt_tcpudp

```

--------------------------------

### Add Brew to PATH

Source: https://www.deploykf.org/guides/local-quickstart

Appends the Homebrew shell environment setup to the user's profile, ensuring the 'brew' command is available in new shell sessions. Requires reopening the shell.

```bash
(echo; echo 'eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)"') >> ~/.profile
```

--------------------------------

### Generate Manifests with deployKF

Source: https://www.deploykf.org/guides/getting-started

Generates Kubernetes manifests using deployKF, merging multiple value files. Specify the source version, value files, and an output directory. Later value files take precedence during merging.

```bash
deploykf generate \
    --source-version "0.1.5" \
    --values ./sample-values-0.1.5.yaml \
    --values ./custom-overrides.yaml \
    --output-dir ./GENERATOR_OUTPUT
```

--------------------------------

### Create ClusterIssuer for Let's Encrypt (YAML)

Source: https://www.deploykf.org/guides/platform/deploykf-gateway

This YAML defines a ClusterIssuer resource for cert-manager, configured to use Let's Encrypt's ACME staging server. It specifies the DNS provider (Google Cloud DNS in this example) and the necessary details for domain verification using the DNS-01 challenge for wildcard and root domains.

```yaml
apiVersion: cert-manager.io/v1
kind: ClusterIssuer
metadata:
  name: my-cluster-issuer
spec:
  acme:
    server: https://acme-staging-v02.api.letsencrypt.org/directory
    email: user@example.com
    privateKeySecretRef:
      name: letsencrypt-staging
      key: tls.key
    solvers:
      - dns01:
          cloudDNS:
            project: my-project-id
            serviceAccountSecretRef:
              name: my-service-account-secret
              key: service-account.json
        selector:
          dnsNames:
            - "*.deploykf.example.com"
            - "deploykf.example.com"
```

--------------------------------

### Configure Istio Required Kernel Modules

Source: https://www.deploykf.org/guides/troubleshooting

This snippet configures the system to load essential kernel modules for Istio on boot. It creates a configuration file in /etc/modules-load.d/. If using Istio ambient mode, additional modules may be required.

```bash
cat <<EOF | sudo tee /etc/modules-load.d/99-istio-modules.conf
br_netfilter
ip_tables
iptable_filter
iptable_mangle
iptable_nat
iptable_raw
nf_nat
x_tables
xt_REDIRECT
xt_conntrack
xt_multiport
xt_owner
xt_tcpudp
EOF
```

--------------------------------

### Update Hosts File for Remote Access (Example)

Source: https://www.deploykf.org/guides/local-quickstart

This example shows how to update the hosts file on a local machine to map deployKF domain names to the IP address of a remote server. This is crucial for accessing deployKF services hosted on a remote server when direct network access is available. Ensure the IP address and domain names are correct for your environment.

```bash
192.168.50.15 deploykf.example.com
192.168.50.15 argo-server.deploykf.example.com
192.168.50.15 minio-api.deploykf.example.com
192.168.50.15 minio-console.deploykf.example.com

```

--------------------------------

### List Loaded Kernel Modules with lsmod

Source: https://www.deploykf.org/guides/troubleshooting

This command lists all currently loaded kernel modules on a Linux system. It is a prerequisite for identifying missing modules required by Istio.

```bash
lsmod | awk '{print $1}' | sort
```

--------------------------------

### Apply App-of-Apps Manifest with kubectl

Source: https://www.deploykf.org/guides/getting-started

Applies the root app-of-apps manifest generated by deployKF using kubectl. This manifest is responsible for creating all other ArgoCD applications within the cluster.

```bash
kubectl apply --filename GENERATOR_OUTPUT/app-of-apps.yaml
```

--------------------------------

### Mirror Container Images with Docker

Source: https://www.deploykf.org/guides/platform/offline

This script demonstrates how to pull an image from a source registry, tag it for a destination registry, and then push it. It's a common workflow for mirroring images to a private container registry.

```bash
# set the source image
SOURCE_REGISTRY="ghcr.io" # depending on image: "docker.io", "grc.io", "ghcr.io", "quay.io"
SOURCE_IMAGE="deploykf/kubeflow-pipelines/cache-server:X.Y.Z"

# set the destination image
DEST_REGISTRY="docker.example.com"
DEST_IMAGE="${SOURCE_IMAGE}"

# pull the images
docker pull "${SOURCE_REGISTRY}/${SOURCE_IMAGE}"

# tag the images
docker tag "${SOURCE_REGISTRY}/${SOURCE_IMAGE}" "${DEST_REGISTRY}/${DEST_IMAGE}"

# push the images
# NOTE: you may need to login first with `docker login ...`
docker push "${DEST_REGISTRY}/${DEST_IMAGE}"
```

--------------------------------

### Commit Generated Manifests to Git

Source: https://www.deploykf.org/guides/getting-started

Commits the generated manifests to a Git repository for version control and subsequent deployment by ArgoCD. This step is crucial for tracking changes and enabling automated deployments.

```bash
# for example, to directly commit changes to the 'main' branch of your repo
git add GENERATOR_OUTPUT
git commit -m "my commit message"
git push origin main
```

--------------------------------

### Apply ArgoCD App-of-Apps Resource using kubectl

Source: https://www.deploykf.org/guides/getting-started

Applies the deployKF App-of-Apps Kubernetes resource to the cluster using kubectl. This command reads the YAML definition from a local file and submits it to the Kubernetes API.

```shell
kubectl apply -f ./deploykf-app-of-apps.yaml
```

--------------------------------

### Render Manifests with deploykf generate

Source: https://www.deploykf.org/guides/platform/offline

This command renders the deployKF manifests to a specified output directory. This is useful for inspecting which container images are used by each component, especially when preparing to mirror them to a private registry.

```bash
# Render the manifests
deploykf generate ... --output-dir ./GENERATOR_OUTPUT

# Go to the component directory
cd ./GENERATOR_OUTPUT/manifests/kubeflow-tools/pipelines
```

--------------------------------

### Get deployKF Gateway Service IP using kubectl

Source: https://www.deploykf.org/guides/platform/deploykf-gateway

This command retrieves the external IP address of the deployKF Gateway Service. This IP is essential for configuring DNS records. Ensure you have kubectl installed and configured to access your Kubernetes cluster.

```bash
kubectl get service deploykf-gateway --namespace deploykf-istio-gateway
```

--------------------------------

### Disable Embedded Istio Installation in deployKF

Source: https://www.deploykf.org/guides/dependencies/istio

Disables deployKF's default Istio installation, allowing you to use your own existing Istio setup. This is a prerequisite for integrating an external Istio.

```yaml
deploykf_dependencies:
  istio:
    enabled: false
```

--------------------------------

### Configure Ingress for TLS Termination

Source: https://www.deploykf.org/guides/platform/deploykf-gateway

An example of a Kubernetes Ingress resource configured to use a specific Secret for TLS termination. The `secretName` field in the `tls` section points to the Kubernetes Secret containing the certificate and key.

```yaml
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: deploykf-gateway
  namespace: deploykf-istio-gateway
  annotations:
    ...
    ...
spec:
  ingressClassName: XXXXXX

  tls:
    ## this tells the Ingress to use `my-tls-secret` for TLS termination
    - secretName: "my-tls-secret"

    ## NOTE: some Ingress controllers allow multiple certificates to be specified
    ##       for different hostnames
    #- secretName: "other-tls-secret"
    #  hosts:
    #    - "*.deploykf.example.com"
    #    - "deploykf.example.com"

rules:
    ...
    ...
```

--------------------------------

### External-DNS Manual Annotation for Service/Ingress (YAML)

Source: https://www.deploykf.org/guides/platform/deploykf-gateway

This example demonstrates how to manually configure External-DNS by annotating Kubernetes Service or Ingress resources. The 'external-dns.alpha.kubernetes.io/hostname' annotation is used, with multiple hostnames specified as a comma-separated list. This can be set within the 'deploykf_core.deploykf_istio_gateway.gatewayService.annotations' value for Services or directly on Ingress resources.

```yaml
# For Service:
# deploykf_core:
#   deploykf_istio_gateway:
#     gatewayService:
#       annotations:
#         external-dns.alpha.kubernetes.io/hostname: "hostname1.example.com,hostname2.example.com"

# For Ingress (manual annotation):
# metadata:
#   annotations:
#     external-dns.alpha.kubernetes.io/hostname: "hostname1.example.com,hostname2.example.com"

```

--------------------------------

### Configure MetalLB LoadBalancer Service for DeployKF

Source: https://www.deploykf.org/guides/platform/deploykf-gateway

This example demonstrates configuring the DeployKF Gateway Service to work with MetalLB for bare-metal Kubernetes clusters. It uses MetalLB-specific annotations to assign a static IP address or select an IP address from a defined pool. The `metallb.universe.tf/loadBalancerIPs` annotation is for a specific IP, while `metallb.universe.tf/address-pool` is for an IP pool.

```yaml
deploykf_core:
  deploykf_istio_gateway:

    ## these values configure the deployKF Gateway Service
    ##
    gatewayService:
      name: "deploykf-gateway"
      type: "LoadBalancer"
      annotations:
        ## for static IP addresses (specific IP)
        metallb.universe.tf/loadBalancerIPs: 192.168.XXX.XXX

        ## for static IP addresses (from IP pool)
        #metallb.universe.tf/address-pool: my-pool-XXX

        ## for external-dns integration (if not `--source=istio-gateway` config)
        #external-dns.alpha.kubernetes.io/hostname: "deploykf.example.com, *.deploykf.example.com"

      ## the ports the gateway Service listens on
      ##  - defaults to the corresponding port under `gateway.ports`
      ##  - these are the "public" ports which clients will connect to
      ##    (they impact the user-facing HTTP links)
      ##
      ports:
        http: 80
        https: 443

```

--------------------------------

### Download and Execute ArgoCD Sync Script

Source: https://www.deploykf.org/guides/local-quickstart

This sequence of commands downloads the latest version of the `sync_argocd_apps.sh` script using curl, makes it executable using chmod, and verifies the current kubectl context. This script automates the synchronization of ArgoCD applications in the correct order, which is essential for a successful deployKF deployment.

```bash
# download the latest version of the script
curl -fL -o "sync_argocd_apps.sh" \
  "https://raw.githubusercontent.com/deployKF/deployKF/main/scripts/sync_argocd_apps.sh"

# ensure the script is executable
chmod +x ./sync_argocd_apps.sh

# ensure your kubectl context is set correctly
kubectl config current-context

```

--------------------------------

### Configure AWS LoadBalancer Service for DeployKF

Source: https://www.deploykf.org/guides/platform/deploykf-gateway

This snippet shows how to configure the DeployKF Gateway Service to use an AWS Network Load Balancer (NLB). It specifies annotations for creating an external, internal NLB targeting IP addresses, and includes options for static IP configurations and subnets. This requires the AWS Load Balancer Controller to be installed on EKS.

```yaml
deploykf_core:
  deploykf_istio_gateway:

    ## these values configure the deployKF Gateway Service
    ##
    gatewayService:
      name: "deploykf-gateway"
      type: "LoadBalancer"
      annotations:
        service.beta.kubernetes.io/aws-load-balancer-type: "external"
        service.beta.kubernetes.io/aws-load-balancer-nlb-target-type: "ip"
        service.beta.kubernetes.io/aws-load-balancer-scheme: "internal"

        ## for external-dns integration (if not `--source=istio-gateway` config)
        #external-dns.alpha.kubernetes.io/hostname: "deploykf.example.com, *.deploykf.example.com"

        ## for static private IP addresses
        #service.beta.kubernetes.io/aws-load-balancer-private-ipv4-addresses: "192.168.XXX.XXX, 192.168.YYY.YYY"
        #service.beta.kubernetes.io/aws-load-balancer-subnets: "subnet-XXX, subnet-YYY"

        ## for static public IP addresses
        #service.beta.kubernetes.io/aws-load-balancer-eip-allocations: "eipalloc-XXX, eipalloc-YYY"
        #service.beta.kubernetes.io/aws-load-balancer-subnets: "subnet-XXX, subnet-YYY"

      ## the ports the gateway Service listens on
      ##  - defaults to the corresponding port under `gateway.ports`
      ##  - these are the "public" ports which clients will connect to
      ##    (they impact the user-facing HTTP links)
      ##
      ports:
        http: 80
        https: 443

```

--------------------------------

### Configure Nginx Ingress for deployKF

Source: https://www.deploykf.org/guides/platform/deploykf-gateway

This snippet demonstrates the configuration for the community Nginx Ingress Controller to work with deployKF. It includes annotations for backend protocol, SSL proxying, and a workaround for a known bug, along with TLS configuration and routing rules for 'deploykf.example.com' and its subdomains.

```yaml
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: deploykf-gateway
  annotations:
    nginx.ingress.kubernetes.io/backend-protocol: HTTPS

    ## nginx wil NOT proxy the SNI by default
    ## see: https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/#backend-certificate-authentication
    nginx.ingress.kubernetes.io/proxy-ssl-name: "deploykf.example.com"
    nginx.ingress.kubernetes.io/proxy-ssl-server-name: "on"

    ## this config is needed due to a bug in ingress-nginx
    ## see: https://github.com/kubernetes/ingress-nginx/issues/6728
    nginx.ingress.kubernetes.io/proxy-ssl-secret: "deploykf-istio-gateway/deploykf-istio-gateway-cert"
spec:
  ingressClassName: nginx
  tls:
    ## NOTE: this secret is created as part of the deployKF installation
    - secretName: "deploykf-istio-gateway-cert"
  rules:
    - host: "deploykf.example.com"
      http:
        paths:
          - path: "/"
            pathType: Prefix
            backend:
              service:
                name: "deploykf-gateway"
                port:
                  name: https
    - host: "*.deploykf.example.com"
      http:
        paths:
          - path: "/"
            pathType: Prefix
            backend:
              service:
                name: "deploykf-gateway"
                port:
                  name: https
```

--------------------------------

### Add Host Entries to /etc/hosts (Linux)

Source: https://www.deploykf.org/guides/local-quickstart

This snippet demonstrates how to add necessary host entries to the `/etc/hosts` file on a Linux system. These entries are crucial for resolving deployKF domain names locally. Requires root privileges.

```text
127.0.0.1 deploykf.example.com
127.0.0.1 argo-server.deploykf.example.com
127.0.0.1 minio-api.deploykf.example.com
127.0.0.1 minio-console.deploykf.example.com
```

--------------------------------

### Open /etc/hosts with nano or vim (Linux)

Source: https://www.deploykf.org/guides/local-quickstart

Commands to open the `/etc/hosts` file using either `nano` or `vim` text editors on Linux. These commands require root privileges to modify the system's hosts file.

```bash
sudo nano /etc/hosts
```

```bash
sudo vim /etc/hosts
```

--------------------------------

### Configure deployKF Base Domain and Ports (YAML)

Source: https://www.deploykf.org/guides/platform/deploykf-gateway

This YAML configuration snippet sets the base domain for deployKF to 'deploykf.example.com' and specifies the ports (80 for HTTP, 443 for HTTPS) that the gateway pods will listen on. It's crucial for ensuring that deployKF can be accessed via the correct hostnames.

```yaml
deploykf_core:
  deploykf_istio_gateway:
    gateway:
      ## the "base domain" for deployKF
      ##  - this domain and its subdomains MUST be dedicated to deployKF
      ##
      hostname: deploykf.example.com

      ## the ports that gateway Pods listen on
      ##  - 80/443 are the defaults, but if you are using 'sample-values.yaml' 
      ##    as a base, the defaults are 8080/8443, so you will need to 
      ##    override them to use the standard ports
      ##
      ports:
        http: 80
        https: 443
```

--------------------------------

### Verify ArgoCD Pods Status

Source: https://www.deploykf.org/guides/local-quickstart

Retrieves the status of all pods within the 'argocd' namespace. This command is used to confirm that ArgoCD and its associated components have started successfully and are running as expected.

```bash
kubectl get --namespace argocd pods

```

--------------------------------

### Configure ArgoCD Application for DeployKF

Source: https://www.deploykf.org/guides/getting-started

Defines an ArgoCD Application resource (App-of-Apps pattern) to manage the DeployKF deployment. It specifies the Git repository source, target revision, path, and plugin configuration, including the deployKF generator version and paths to values files.

```yaml
apiVersion: argoproj.io/v1alpha1
kind: Application
metadata:
  name: deploykf-app-of-apps
  namespace: argocd
  labels:
    app.kubernetes.io/name: deploykf-app-of-apps
    app.kubernetes.io/part-of: deploykf
spec:
  project: "default"
  source:
    ## source git repo configuration
    ##
    repoURL: "https://github.com/MY_GITHUB_ORG/MY_GITHUB_REPO.git"
    targetRevision: "main"
    path: "."
    ## plugin configuration
    ##
    plugin:
      name: "deploykf"
      parameters:
        ## the deployKF generator version
        ##
        - name: "source_version"
          string: "0.1.5"
        ## paths to values files within the `repoURL` repository
        ##
        - name: "values_files"
          array:
            - "./sample-values-0.1.5.yaml"
            - "./values-1.yaml"
            - "./values-2.yaml"
        ## a string containing the contents of a values file
        ##  - this parameter allows defining values without needing to create a file in the repo
        ##  - these values are merged with higher precedence than those defined in `values_files`
        ##
        #- name: "values"
        #  string: |
        #    ...
        #    values file contents
        #    ...
  destination:
    server: "https://kubernetes.default.svc"
    namespace: "argocd"
```

--------------------------------

### Create k3d Cluster

Source: https://www.deploykf.org/guides/local-quickstart

Creates a local Kubernetes cluster named 'deploykf' using the k3d command-line tool. k3d runs K3s clusters within Docker, providing a lightweight Kubernetes environment.

```bash
k3d cluster create deploykf
```

--------------------------------

### Manage Kubectl Contexts with Kubectx

Source: https://www.deploykf.org/guides/local-quickstart

Provides commands to list all available kubectl contexts and set the current context to a specific cluster. This is essential for ensuring kubectl commands target the correct Kubernetes environment.

```bash
# list all contexts
kubectx

# set the current context to 'k3d-deploykf'
kubectx "k3d-deploykf"

```

--------------------------------

### Check Current Kubectl Context

Source: https://www.deploykf.org/guides/local-quickstart

Verifies the current kubectl context to ensure operations are performed on the intended Kubernetes cluster. This is crucial before installing services like ArgoCD to prevent accidental deployment to the wrong cluster.

```bash
# get the name of the current kubectl context
kubectl config current-context

```

--------------------------------

### Open hosts file with Notepad (Windows)

Source: https://www.deploykf.org/guides/local-quickstart

This PowerShell command opens the hosts file (`C:\Windows\System32\drivers\etc\hosts`) with Notepad on Windows, requesting Administrator privileges. This is necessary for modifying the file.

```powershell
Start-Process notepad.exe -ArgumentList "C:\Windows\System32\drivers\etc\hosts" -Verb RunAs
```

--------------------------------

### Download Sample Values File (Shell)

Source: https://www.deploykf.org/guides/values

This command downloads the sample values file for a specific version of deployKF using curl. The '-fL' flags ensure that the command fails if the server does not return an error code and that it follows redirects. The '-o' flag specifies the output filename.

```shell
curl -fL -o "sample-values-0.1.5.yaml" \
  "https://raw.githubusercontent.com/deployKF/deployKF/v0.1.5/sample-values.yaml"

```