🌐 EGS Installer Script

🚀 Overview

The EGS Installer Script is a Bash script designed to streamline the installation, upgrade, and configuration of EGS components in Kubernetes clusters. It leverages Helm for package management, kubectl for interacting with Kubernetes clusters, and yq for parsing YAML files. The script allows for automated validation of cluster access, installation of required binaries, and the creation of Kubernetes namespaces and resources.

📄 EGS Documents

📖 For EGS platform overview, please see the Platform Overview Documentation 🌐
🔧 For the Admin guide, please see the Admin Guide Documentation 🛠️
👤 For the User guide, please see the User Guide Documentation 📚
🛠️ For the Installation guide, please see the documentation on GitHub Repo 💻

Getting Started

Prerequisites

Before you begin, ensure the following steps are completed:

📝 Registration:
- Complete the registration process at Avesha Registration to receive the image pull secrets required for running the script.
🔧 Required Binaries:
- Verify that the following binaries are installed and available in your system's PATH:
  - yq 📄 (minimum version: 4.44.2)
  - helm 🛠️ (minimum version: 3.15.0)
  - kubectl ⚙️ (minimum version: 1.23.6)
  - jq 📦 (minimum version: 1.6.0)
🌐 Kubernetes Access:
- Confirm that you have administrative access to the necessary Kubernetes clusters and the appropriate kubeconfig files are available.

🛠️ Installation Steps

📂 Clone the Repository:
- Start by cloning the EGS installation Git repository:
```
git clone https://github.com/kubeslice-ent/egs-installation
```

📝 Modify the Configuration File:

Navigate to the cloned repository and locate the input configuration YAML file egs-installer-config.yaml.

Update the following mandatory parameters:

🔑 Image Pull Secrets:

Insert the image pull secrets received via email as part of the registration process:

global_image_pull_secret:
  repository: "https://index.docker.io/v1/"
  username: ""  # Global Docker registry username (MANDATORY)
  password: ""  # Global Docker registry password (MANDATORY)

⚙️ Kubernetes Configuration:

Set the global kubeconfig and kubecontext parameters:

global_kubeconfig: ""  # Relative path to global kubeconfig file from base_path default is script directory (MANDATORY)
global_kubecontext: ""  # Global kubecontext (MANDATORY)

🚀 Run the Installation Script:
- Execute the installation script using the following command:
```
./egs-installer.sh --input-yaml egs-installer-config.yaml
```

🔄 Update the Inline Values:

Update the inline-values of kubeslice-worker-egs in egs-installer-config.yaml with the Grafana LB External IP:

Fetch the external IP using the following command:
```
kubectl get svc prometheus-grafana -n monitoring
```

Update the kubeslice-worker-egs configuration with the Grafana LB external IP in egs-installer-config.yaml:

inline_values:  # Inline Helm values for the worker chart
  kubesliceNetworking:
    enabled: false  # Disable Kubeslice networking for this worker
  egs:
    prometheusEndpoint: "http://prometheus-kube-prometheus-prometheus.monitoring.svc.cluster.local:9090"  # Prometheus endpoint
    grafanaDashboardBaseUrl: "http://<grafana-lb>/d/Oxed_c6Wz"
  metrics:
    insecure: true  # Allow insecure connections for metrics

🔄 Run the Installation Script Again:
- Apply the updated configuration by running the installation script again:
```
./egs-installer.sh --input-yaml egs-installer-config.yaml
```

Uninstallation Steps

Run the Cleanup Script

Execute the uninstallation script using the following command:
```
./egs-uninstall.sh --input-yaml egs-installer-config.yaml
```

🛠️ Configuration details

The script requires a YAML configuration file to define various parameters and settings for the installation process. Below is an example configuration file (egs-installer-config.yaml) with descriptions for each section.

⚠️ Warning

Do not copy the YAML configuration directly from this README. Hash characters (#) used for comments may not be interpreted correctly. Always refer to the actual egs-installer-config.yaml file available in the repository for accurate configuration.

YAML Configuration File

# Base path to the root directory of your cloned repository
base_path: ""  # If left empty, the script will use the relative path to the script as the base path

# Precheck options
precheck: true  # Run general prechecks before starting the installation
kubeslice_precheck: true  # Run specific prechecks for Kubeslice components

# Global installation verification settings
verify_install: true  # Enable verification of installations globally
verify_install_timeout: 600  # Timeout for global installation verification (in seconds)
skip_on_verify_fail: false  # If set to true, skip steps where verification fails, otherwise exit on failure

# Helm repository settings
use_local_charts: true  # Use local Helm charts instead of fetching them from a repository
local_charts_path: "charts"  # Path to the directory containing local Helm charts
global_helm_repo_url: ""  # URL for the global Helm repository (if not using local charts)
global_helm_username: ""  # Username for accessing the global Helm repository
global_helm_password: ""  # Password for accessing the global Helm repository
readd_helm_repos: true  # Re-add Helm repositories even if they are already present

# List of required binaries for the installation process
required_binaries:
  - yq  # YAML processor
  - helm  # Helm package manager
  - jq  # JSON processor
  - kubectl  # Kubernetes command-line tool

# Global image pull secret settings
global_image_pull_secret:
  repository: "https://index.docker.io/v1/"  # Docker registry URL
  username: ""  # Global Docker registry username
  password: ""  # Global Docker registry password

# Node labeling settings
add_node_label: true  # Enable node labeling during installation

# Kubeconfig settings
global_kubeconfig: ""  # Path to the global kubeconfig file (used if no specific kubeconfig is provided)
global_kubecontext: ""  # Global kubecontext to use; if empty, the default context will be used
use_global_context: true  # If true, use the global kubecontext for all operations by default

# Enable or disable specific stages of the installation
enable_prepare_worker_values_file: true  # Prepare the worker values file for Helm charts
enable_install_controller: true  # Enable the installation of the Kubeslice controller
enable_install_ui: true  # Enable the installation of the Kubeslice UI
enable_install_worker: true  # Enable the installation of Kubeslice workers

# Kubeslice controller installation settings
kubeslice_controller_egs:
  skip_installation: false  # Do not skip the installation of the controller
  use_global_kubeconfig: true  # Use global kubeconfig for the controller installation
  specific_use_local_charts: true  # Override to use local charts for the controller
  kubeconfig: ""  # Path to the kubeconfig file specific to the controller
  kubecontext: ""  # Kubecontext specific to the controller; if empty, uses the global context
  namespace: "kubeslice-controller"  # Kubernetes namespace where the controller will be installed
  release: "kubeslice-controller-release"  # Helm release name for the controller
  chart: "kubeslice-controller-egs"  # Helm chart name for the controller
  inline_values:  # Inline Helm values for the controller chart
    kubeslice:
      controller: 
        endpoint: ""  # Endpoint of the controller API server; auto-fetched if left empty
        migration:
          minio:
            install: "false"  # Do not install MinIO during migration
  helm_flags: "--timeout 10m --atomic"  # Additional Helm flags for the installation
  verify_install: true  # Verify the installation of the controller
  verify_install_timeout: 30  # Timeout for the controller installation verification (in seconds)
  skip_on_verify_fail: false  # If verification fails, do not skip the step

# Kubeslice UI installation settings
kubeslice_ui_egs:
  skip_installation: false  # Do not skip the installation of the UI
  use_global_kubeconfig: true  # Use global kubeconfig for the UI installation
  namespace: "kubeslice-controller"  # Kubernetes namespace where the UI will be installed
  release: "kubeslice-ui"  # Helm release name for the UI
  chart: "kubeslice-ui-egs"  # Helm chart name for the UI
  helm_flags: "--atomic"  # Additional Helm flags for the UI installation
  verify_install: true  # Verify the installation of the UI
  verify_install_timeout: 50  # Timeout for the UI installation verification (in seconds)
  skip_on_verify_fail: false  # If UI verification fails, do not skip the step
  specific_use_local_charts: true  # Override to use local charts for the UI

# Kubeslice worker installation settings
kubeslice_worker_egs:
  - name: "worker-1"
    use_global_kubeconfig: true  # Use global kubeconfig for this worker
    skip_installation: false  # Do not skip the installation of the worker
    specific_use_local_charts: true  # Override to use local charts for this worker
    namespace: "kubeslice-system"  # Kubernetes namespace for this worker
    release: "kubeslice-worker1-release"  # Helm release name for the worker
    chart: "kubeslice-worker-egs"  # Helm chart name for the worker
    inline_values:  # Inline Helm values for the worker chart
      cluster:
        name: worker-1
        endpoint: <worker-cluster-endpoint> # Cluster Endpoint Accessible from Controller Cluster
      kubesliceNetworking:
        enabled: false  # Disable Kubeslice networking for this worker
      egs:
        prometheusEndpoint: "http://prometheus-kube-prometheus-prometheus.monitoring.svc.cluster.local:9090"  # Prometheus endpoint
        grafanaDashboardBaseUrl: "http://grafana-test"  # Grafana dashboard base URL
      metrics:
        insecure: true  # Allow insecure connections for metrics
    helm_flags: "--atomic"  # Additional Helm flags for the worker installation
    verify_install: true  # Verify the installation of the worker
    verify_install_timeout: 60  # Timeout for the worker installation verification (in seconds)
    skip_on_verify_fail: false  # Do not skip if worker verification fails

# Project and cluster registration settings
enable_project_creation: true  # Enable project creation in Kubeslice
enable_cluster_registration: true  # Enable cluster registration in Kubeslice

# Define projects
projects:
  - name: "avesha"
    username: "admin"  # Username for accessing the Kubeslice project

# Define cluster registration
cluster_registration:
  - cluster_name: "worker-1"
    project_name: "avesha"
    telemetry:
      enabled: true  # Enable telemetry for this cluster
      endpoint: "http://prometheus-kube-prometheus-prometheus.monitoring.svc.cluster.local:9090"  # Telemetry endpoint
      telemetryProvider: "prometheus"  # Telemetry provider (Prometheus in this case)
    geoLocation:
      cloudProvider: "GCP"  # Cloud provider for this cluster (e.g., GCP)
      cloudRegion: "us-central1"  # Cloud region for this cluster (e.g., us-central1)

# Enable or disable the installation of additional applications
enable_install_additional_apps: true  # Set to true to enable additional apps installation

# Define additional applications to install
additional_apps:
  - name: "gpu-operator"
    skip_installation: false  # Do not skip the installation of the GPU operator
    use_global_kubeconfig: true  # Use global kubeconfig for this application
    namespace: "gpu-operator"  # Namespace where the GPU operator will be installed
    release: "gpu-operator-release"  # Helm release name for the GPU operator
    chart: "gpu-operator"  # Helm chart name for the GPU operator
    repo_url: "https://helm.ngc.nvidia.com/nvidia"  # Helm repository URL for the GPU operator
    version: "v24.6.0"  # Version of the GPU operator to install
    specific_use_local_charts: true  # Use local charts for this application
    inline_values:  # Inline Helm values for the GPU operator chart
      hostPaths:
        driverInstallDir: "/home/kubernetes/bin/nvidia"
      toolkit:
        installDir: "/home/kubernetes/bin/nvidia"
      cdi:
        enabled: true
        default: true
      driver:
        enabled: false
    helm_flags: "--wait"  # Additional Helm flags for this application's installation
    verify_install: true  # Verify the installation of the GPU operator
    verify_install_timeout: 600  # Timeout for verification (in seconds)
    skip_on_verify_fail: false  # Do not skip if verification fails

  - name: "prometheus"
    skip_installation: false  # Do not skip the installation of Prometheus
    use_global_kubeconfig: true  # Use global kubeconfig for Prometheus
    namespace: "monitoring"  # Namespace where Prometheus will be installed
    release: "prometheus"  # Helm release name for Prometheus
    chart: "kube-prometheus-stack"  # Helm chart name for Prometheus
    repo_url: "https://prometheus-community.github.io/helm-charts"  # Helm repository URL for Prometheus
    version: "v45.0.0"  # Version of the Prometheus stack to install
    specific_use_local_charts: true  # Use local charts for this application
    values_file: ""  # Path to an external values file, if any
    inline_values:  # Inline Helm values for Prometheus
      prometheus:
        service:
          type: LoadBalancer
          port: 32270
        prometheusSpec:
          additionalScrapeConfigs:
          - job_name: tgi
            kubernetes_sd_configs:
            - role: endpoints
            relabel_configs:
            - source_labels: [__meta_kubernetes_pod_name]
              target_label: pod_name
            - source_labels: [__meta_kubernetes_pod_container_name]
              target_label: container_name
            static_configs:
              - targets: ["llm-inference.demo.svc.cluster.local:80"]
          - job_name: gpu-metrics
            scrape_interval: 1s
            metrics_path: /metrics
            scheme: http
            kubernetes_sd_configs:
            - role: endpoints
              namespaces:
                names:
                - gpu-operator
            relabel_configs:
            - source_labels: [__meta_kubernetes_endpoints_name]
              action: drop
              regex: .*-node-feature-discovery-master
            - source_labels: [__meta_kubernetes_pod_node_name]
              action: replace
              target_label: kubernetes_node
      grafana:
        enabled: true
        grafana.ini:
          auth:
            disable_login_form: true
            disable_signout_menu: true
          auth.anonymous:
            enabled: true
            org_role: Viewer
        service:
          type: LoadBalancer
        persistence:
          enabled: true
          size: 1Gi
    helm_flags: "--wait"  # Additional Helm flags for this application's installation
    verify_install: true  # Verify the installation of Prometheus
    verify_install_timeout: 600  # Timeout for verification (in seconds)
    skip_on_verify_fail: false  # Do not skip if verification fails

# Enable custom applications
enable_custom_apps: true  # Set to true to enable custom apps

# Define custom applications and their associated manifests
manifests:
  - appname: gpu-operator-quota
    manifest: ""  # URL or path to the manifest file; if empty, inline YAML is used
    overrides_yaml: ""  # Path to an external YAML file with overrides, if any
    inline_yaml: |  # Inline YAML content for this custom application
      apiVersion: v1
      kind: ResourceQuota
      metadata:
        name: gpu-operator-quota
      spec:
        hard:
          pods: 100
        scopeSelector:
          matchExpressions:
          - operator: In
            scopeName: PriorityClass
            values:
              - system-node-critical
              - system-cluster-critical
    use_global_kubeconfig: true  # Use global kubeconfig for this application
    skip_installation: false  # Do not skip the installation of this application
    verify_install: true  # Verify the installation of this application
    verify_install_timeout: 30  # Timeout for verification (in seconds)
    skip_on_verify_fail: false  # Do not skip if verification fails
    namespace: gpu-operator  # Namespace for this application
    kubeconfig: ""  # Path to the kubeconfig file specific to this application
    kubecontext: ""  # Kubecontext specific to this application; uses global context if empty

  - appname: nvidia-driver-installer
    manifest: https://raw.githubusercontent.com/GoogleCloudPlatform/container-engine-accelerators/master/nvidia-driver-installer/cos/daemonset-preloaded.yaml
    overrides_yaml: ""  # Path to an external YAML file with overrides, if any
    inline_yaml: null  # Inline YAML content for this application
    use_global_kubeconfig: true  # Use global kubeconfig for this application
    skip_installation: false  # Do not skip the installation of this application
    verify_install: true  # Verify the installation of this application
    verify_install_timeout: 200  # Timeout for verification (in seconds)
    skip_on_verify_fail: true  # Skip if verification fails
    namespace: kube-system  # Namespace for this application
    
# Command execution settings
run_commands: true  # Enable the execution of commands defined in the YAML

# Define commands to execute
commands:
  - use_global_kubeconfig: true  # Use global kubeconfig for these commands
    skip_installation: false  # Do not skip the execution of these commands
    verify_install: true  # Verify the execution of these commands
    verify_install_timeout: 200  # Timeout for verification (in seconds)
    skip_on_verify_fail: true  # Skip if command verification fails
    namespace: kube-system  # Namespace context for these commands
    command_stream: |  # Commands to execute
      kubectl get nodes
      kubectl get nodes -o json | jq -r '.items[] | select(.status.capacity["nvidia.com/gpu"] != null) | .metadata.name' | xargs -I {} kubectl label nodes {} gke-no-default-nvidia-gpu-device-plugin=true --overwrite

Explanation of YAML Fields

Field	Description	Default/Example
`base_path`	Base path to the root directory of the cloned repository. If empty, the script uses the relative path to the script as the base path.	`""` (empty string)
`precheck`	Run prechecks before installation to validate the environment and required binaries.	`true`
`kubeslice_precheck`	Run specific prechecks for Kubeslice components, including cluster access validation and node label checks.	`true`
`verify_install`	Enable installation verification globally, ensuring that all installed components are running as expected.	`true`
`verify_install_timeout`	Global timeout for verification in seconds. Determines how long the script waits for all components to be verified as running.	`600` (10 minutes)
`skip_on_verify_fail`	Decide whether to skip further steps or exit the script if verification fails globally.	`false`
`global_helm_repo_url`	URL of the global Helm repository from which charts will be pulled.	Helm Repository
`global_helm_username`	Username for accessing the global Helm repository, if required.	`""`
`global_helm_password`	Password for accessing the global Helm repository, if required.	`""`
`readd_helm_repos`	Re-add Helm repositories if they already exist to ensure the latest repository configuration is used.	`true`
`required_binaries`	List of binaries that are required for the installation process. The script will check for these binaries and exit if any are missing.	`yq`, `helm`, `kubectl`
`global_image_pull_secret`	Global image pull secret settings for accessing private Docker registries.	Repository: `https://index.docker.io/v1/`, Username: `""`, Password: `""`
`add_node_label`	Enable node labeling during installation, useful for reserving nodes for specific tasks.	`true`
`global_kubeconfig`	Relative path to the global kubeconfig file used to access Kubernetes clusters.	`""` (empty string)
`use_local_charts`	Use local Helm charts instead of pulling them from a repository, useful for testing or restricted access scenarios.	`true`
`local_charts_path`	Relative path to the local Helm charts directory, used only if `use_local_charts` is set to `true`.	`"charts"`
`global_kubecontext`	Global kubecontext to be used across all Kubernetes interactions. If empty, the default context will be used.	`""` (empty string)
`use_global_context`	Use the global kubecontext by default for all operations unless a specific context is provided for a component.	`true`
`enable_prepare_worker_values_file`	Enable the preparation of the worker values file before installation, necessary if the worker configuration depends on dynamic values.	`true`
`enable_install_controller`	Enable the installation of the Kubeslice controller.	`true`
`enable_install_ui`	Enable the installation of the Kubeslice UI.	`true`
`enable_install_worker`	Enable the installation of the Kubeslice worker.	`true`

`kubeslice_controller_egs` Subfields

Subfield	Description	Default/Example
`skip_installation`	Skip the installation of the Kubeslice controller if it's already installed or not needed.	`false`
`use_global_kubeconfig`	Use the global kubeconfig file for the controller installation.	`true`
`specific_use_local_charts`	Use local charts specifically for the controller installation, overriding the global `use_local_charts` setting.	`true`
`kubeconfig`	Relative path to the kubeconfig file for the controller. Overrides the global kubeconfig if specified.	`""` (empty string)
`kubecontext`	Specific kubecontext for the controller installation, uses the global context if empty.	`""` (empty string)
`namespace`	Kubernetes namespace where the Kubeslice controller will be installed.	`"kubeslice-controller"`
`release`	Helm release name for the Kubeslice controller.	`"kubeslice-controller-release"`
`chart`	Helm chart name used for installing the Kubeslice controller.	`"kubeslice-controller-egs"`
`inline_values`	Inline values passed to the Helm chart during installation. For example, setting the controller endpoint.	`kubeslice.controller.endpoint: ""`
`helm_flags`	Additional Helm flags for the controller installation, such as timeout and atomic deployment.	`"--timeout 10m --atomic"`
`verify_install`	Verify the installation of the Kubeslice controller after deployment.	`true`
`verify_install_timeout`	Timeout for verifying the installation of the controller, in seconds.	`30` (30 seconds)
`skip_on_verify_fail`	Skip further steps or exit if the controller verification fails.	`false`

`kubeslice_ui_egs` Subfields

Subfield	Description	Default/Example
`skip_installation`	Skip the installation of the Kubeslice UI if it's already installed or not needed.	`false`
`use_global_kubeconfig`	Use the global kubeconfig file for the UI installation.	`true`
`specific_use_local_charts`	Use local charts specifically for the UI installation, overriding the global `use_local_charts` setting.	`true`
`namespace`	Kubernetes namespace where the Kubeslice UI will be installed.	`"kubeslice-controller"`
`release`	Helm release name for the Kubeslice UI.	`"kubeslice-ui"`
`chart`	Helm chart name used for installing the Kubeslice UI.	`"kubeslice-ui-egs"`
`helm_flags`	Additional Helm flags for the UI installation, such as atomic deployment.	`"--atomic"`
`verify_install`	Verify the installation of the Kubeslice UI after deployment.	`true`
`verify_install_timeout`	Timeout for verifying the installation of the UI, in seconds.	`50` (50 seconds)
`skip_on_verify_fail`	Skip further steps or exit if the UI verification fails.	`false`

`kubeslice_worker_egs` Subfields

Subfield	Description	Default/Example
`name`	Name of the worker node configuration.	`"worker-1"`
`use_global_kubeconfig`	Use the global kubeconfig file for the worker installation.	`true`
`skip_installation`	Skip the installation of the worker if it's already installed or not needed.	`false`
`specific_use_local_charts`	Use local charts specifically for the worker installation, overriding the global `use_local_charts` setting.	`true`
`namespace`	Kubernetes namespace where the worker will be installed.	`"kubeslice-system"`
`release`	Helm release name for the worker.	`"kubeslice-worker1-release"`
`chart`	Helm chart name used for installing the worker.	`"kubeslice-worker-egs"`
`inline_values`	Inline values passed to the Helm chart during installation. For example, disabling networking and setting Prometheus endpoints.	`kubesliceNetworking.enabled: false`, `egs.prometheusEndpoint: "http://prometheus-test"`, `egs.grafanaDashboardBaseUrl: "http://grafana-test"`, `metrics.insecure: true`
`helm_flags`	Additional Helm flags for the worker installation, such as atomic deployment.	`"--atomic"`
`verify_install`	Verify the installation of the worker after deployment.	`true`
`verify_install_timeout`	Timeout for verifying the installation of the worker, in seconds.	`60` (60 seconds)
`skip_on_verify_fail`	Skip further steps or exit if the worker verification fails.	`false`

`Custom App Manifests` Subfields

Field	Description	Type	Required	Example
`manifests`	A list of manifest configurations. Each entry defines how a specific Kubernetes manifest should be applied.	`list`	Yes	See below for individual fields.
`manifests[].appname`	The name of the application or resource. Used for logging and identification purposes.	`string`	Yes	`nginx-deployment`
`manifests[].manifest`	The path to the Kubernetes manifest file. Can be a local file or an HTTPS URL.	`string`	No	`nginx/deployment.yaml` or `https://raw.githubusercontent.com/.../nginx-app.yaml`
`manifests[].overrides_yaml`	The path to a YAML file containing overrides for the base manifest. Merges with the base manifest before applying.	`string`	No	`nginx/overrides.yaml`
`manifests[].inline_yaml`	Inline YAML content to be merged with the base manifest. Allows for quick, in-line customization without separate files.	`string` (YAML)	No	See inline YAML example below.
`manifests[].use_global_kubeconfig`	Determines whether the global kubeconfig and context should be used. If `false`, specific kubeconfig and context must be provided.	`boolean`	Yes	`true`
`manifests[].kubeconfig_path`	Path to a specific Kubernetes configuration file to be used instead of the global kubeconfig.	`string`	No	`/path/to/specific/kubeconfig`
`manifests[].kubecontext`	The context name in the specific Kubernetes configuration file to be used for this manifest.	`string`	No	`specific-context`
`manifests[].skip_installation`	Whether to skip the installation of this manifest. Useful for conditional deployments.	`boolean`	Yes	`false`
`manifests[].verify_install`	Whether to verify that the application or resource was successfully deployed.	`boolean`	Yes	`true`
`manifests[].verify_install_timeout`	The timeout in seconds for the installation verification.	`integer`	Yes	`60`
`manifests[].skip_on_verify_fail`	Whether to skip the remaining operations if the verification fails.	`boolean`	Yes	`false`
`manifests[].namespace`	The Kubernetes namespace where the resources should be applied.	`string`	Yes	`nginx-namespace`

### 🧑‍💻 Script Usage
To run the script, use the following command:

./egs-installer.sh --input-yaml <yaml_file>

Replace <yaml_file> with the path to your YAML configuration file. For example:

./egs-installer.sh --input-yaml egs-installer-config.yaml

💡 Command-Line Options

--input-yaml <yaml_file>: Specifies the YAML configuration file to be used.
--help: Displays usage information.

🔑 slice & admin Token Retrieval Script - `fetch_egs_slice_token.sh`

fetch_egs_slice_token.sh is a Bash script designed to retrieve tokens for Kubernetes slices and admin users within a specified project/namespace. This script can fetch read-only, read-write, and admin tokens based on the provided arguments, making it flexible for various Kubernetes authentication requirements.

📋 Usage

./fetch_egs_slice_token.sh -k <kubeconfig_absolute_path> [-s <slice_name>] -p <project_name> [-a] -u <username1,username2,...>

🔹 Parameters

-k, --kubeconfig (required): Absolute path to the kubeconfig file used to connect to the Kubernetes cluster.
-s, --slice (optional if -a is provided): Name of the slice for which the tokens are to be retrieved.
-p, --project (required): Name of the project (namespace) where the slice is located.
-a, --admin (optional): Fetch admin tokens for specified usernames (makes --slice optional).
-u, --username (required with -a): Comma-separated list of usernames for fetching admin tokens.
-h, --help: Display help message.

🚀 Examples

1️⃣ Fetching Slice Tokens Only

Retrieve read-only and read-write tokens for a specified slice:

./fetch_egs_slice_token.sh -k /path/to/kubeconfig -s pool1 -p avesha

Explanation: This command fetches tokens for the slice pool1 in the namespace kubeslice-avesha.
Parameters:
- -k /path/to/kubeconfig: Specifies the path to the kubeconfig file.
- -s pool1: Specifies the slice name (pool1).
- -p avesha: Specifies the project/namespace name (avesha).

2️⃣ Fetching Admin Tokens Only

Fetch admin tokens for specific users. When the -a flag is used, --slice becomes optional.

./fetch_egs_slice_token.sh -k /path/to/kubeconfig -p avesha -a -u admin,dev

Explanation: This command fetches admin tokens for both admin and dev users in the namespace kubeslice-avesha.
Parameters:
- -k /path/to/kubeconfig: Specifies the path to the kubeconfig file.
- -p avesha: Specifies the project/namespace name (avesha).
- -a: Indicates that we are fetching admin tokens.
- -u admin,dev: Specifies a comma-separated list of usernames (admin and dev).

3️⃣ Fetching Both Slice and Admin Tokens

Retrieve both slice tokens and admin tokens in a single command:

./fetch_egs_slice_token.sh -k /path/to/kubeconfig -s pool1 -p avesha -a -u admin,dev

Explanation: This command retrieves both read-only and read-write tokens for slice pool1 and admin tokens for admin and dev in the namespace kubeslice-avesha.
Parameters:
- -k /path/to/kubeconfig: Specifies the path to the kubeconfig file.
- -s pool1: Specifies the slice name (pool1).
- -p avesha: Specifies the project/namespace name (avesha).
- -a: Indicates that we are fetching admin tokens.
- -u admin,dev: Specifies a comma-separated list of usernames (admin and dev).

🛠️ Help

For more details on usage or troubleshooting, you can refer to the help option:

./fetch_egs_slice_token.sh --help

🔑 Key Features

Prerequisite Checks: Ensures that required binaries are installed. 🛠️
Kubeslice Pre-Checks: Validates access to clusters and labels nodes if required. ✅
Helm Chart Management: Adds, updates, or removes Helm repositories and manages chart installations. 📦
Project and Cluster Management: Automates the creation of projects and registration of clusters in the Kubeslice controller. 🗂️
Worker Configuration: Fetches secrets from the controller cluster, prepares worker-specific values files, and manages worker installations. ⚙️

📜 Example Workflow

Run Pre-checks: The script first validates that all prerequisites are met. ✅
Kubeslice Pre-Checks: Validates that the script can access all necessary clusters. 🔍
Install or Upgrade Helm Charts:
- Installs or upgrades the Kubeslice controller. 📦
- Installs or upgrades the Kubeslice UI. 💻
Project and Cluster Management:
- Creates defined projects in the Kubeslice controller. 🗂️
- Registers defined clusters within these projects. 🌍
Worker Installation: Installs or upgrades worker nodes, applying the necessary configuration. ⚙️

📝 Notes

Ensure the YAML configuration file is correctly formatted and contains all necessary fields. 📄
The script will exit with an error if any critical steps fail unless configured to skip on failure. ❌
Paths specified in the YAML file should be relative to the base_path unless absolute paths are used. 📁

🛠️ Troubleshooting

Missing Binaries: Ensure all required binaries are installed and accessible in your system's PATH. ⚠️
Cluster Access Issues: Verify that kubeconfig files are correctly configured and that the script can access the clusters specified in the YAML configuration. 🔧
Timeouts: If a component fails to install within the specified timeout, increase the verify_install_timeout in the YAML file. ⏳

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

🌐 EGS Installer Script

🚀 Overview

📄 EGS Documents

Getting Started

Prerequisites

🛠️ Installation Steps

Uninstallation Steps

🛠️ Configuration details

⚠️ Warning

YAML Configuration File

Explanation of YAML Fields

`kubeslice_controller_egs` Subfields

`kubeslice_ui_egs` Subfields

`kubeslice_worker_egs` Subfields

`Custom App Manifests` Subfields

💡 Command-Line Options

🔑 slice & admin Token Retrieval Script - `fetch_egs_slice_token.sh`

📋 Usage

🔹 Parameters

🚀 Examples

1️⃣ Fetching Slice Tokens Only

2️⃣ Fetching Admin Tokens Only

3️⃣ Fetching Both Slice and Admin Tokens

🛠️ Help

🔑 Key Features

📜 Example Workflow

📝 Notes

🛠️ Troubleshooting

About

Releases 14

Packages

Contributors 8

Languages

Name		Name	Last commit message	Last commit date
Latest commit History 342 Commits
charts		charts
docs		docs
egs-apis		egs-apis
.gitignore		.gitignore
README.md		README.md
egs-installer-config.yaml		egs-installer-config.yaml
egs-installer.sh		egs-installer.sh
egs-uninstall.sh		egs-uninstall.sh
fetch_egs_slice_token.sh		fetch_egs_slice_token.sh

kubeslice-ent/egs-installation

Folders and files

Latest commit

History

Repository files navigation

🌐 EGS Installer Script

🚀 Overview

📄 EGS Documents

Getting Started

Prerequisites

🛠️ Installation Steps

Uninstallation Steps

🛠️ Configuration details

⚠️ Warning

YAML Configuration File

Explanation of YAML Fields

kubeslice_controller_egs Subfields

kubeslice_ui_egs Subfields

kubeslice_worker_egs Subfields

Custom App Manifests Subfields

💡 Command-Line Options

🔑 slice & admin Token Retrieval Script - fetch_egs_slice_token.sh

📋 Usage

🔹 Parameters

🚀 Examples

1️⃣ Fetching Slice Tokens Only

2️⃣ Fetching Admin Tokens Only

3️⃣ Fetching Both Slice and Admin Tokens

🛠️ Help

🔑 Key Features

📜 Example Workflow

📝 Notes

🛠️ Troubleshooting

About

Resources

Stars

Watchers

Forks

Releases 14

Packages 0

Contributors 8

Languages

`kubeslice_controller_egs` Subfields

`kubeslice_ui_egs` Subfields

`kubeslice_worker_egs` Subfields

`Custom App Manifests` Subfields

🔑 slice & admin Token Retrieval Script - `fetch_egs_slice_token.sh`

Packages