Understanding Workspaces - padogrid/padogrid GitHub Wiki
◀️ Managing-Workspaces :link: Understanding Clusters ▶️
Once you switched into a workspace, you are able to run all the PadoGrid features completely isolated from other workspaces and product versions. All of your work is stored in the workspace directory. You can think of a workspace as a sandbox in which you can safely create clusters, pods, apps, and bundles without affecting other workspaces. Workspaces typically have the following directory structure.
myws
├── .addonenv.sh
├── apps
│ ├── README.md
│ ├── desktop
│ ├── grafana
│ └── perf_test
├── clusters
├── docker
├── initenv.sh
├── k8s
├── pods
└── setenv.sh
Workspace Shell Files
Every workspace comes with the shell files described below. They contain environment variables that are specific to the workspace.
setenv.sh
In the workspace's setenv.sh
file, you can override the environment variables defined in the RWE's setenv.sh
file or introduce new environment variables. This file is imported by all PadoGrid commands allowing you to set or override workspace-wide environment variables. The following environment variables are typically set in this file.
Environment Variables | Descriptions |
---|---|
COHERENCE_HOME | Coherence home directory path. Overrides the default Coherence path set in RWE setenv.sh . |
CONFLUENT_HOME | Confluent home directory path. Overrides the default Confluent path set in RWE setenv.sh . |
HADOOP_HOME | Hadoop home directory path. Overrides the default Hadoop path set in RWE setenv.sh . |
GEMFIRE_HOME | GemFire home directory path. Overrides the default GemFire path set in RWE setenv.sh . |
GEODE_HOME | Geode home directory path. Overrides the default Geode path set in RWE setenv.sh . |
HAZELCAST_HOME | Hazelcast home directory path. Overrides the default Hazelcast path set in RWE setenv.sh . |
JAVA_HOME | JDK home directory path. |
JET_HOME | Jet home directory path. Overrides the default Jet path set in RWE setenv.sh . |
KAFKA_HOME | Kafka home directory path. Overrides the default Kafka path set in RWE setenv.sh . |
PADOGRID_HOME | PadoGrid home directory path. This path is automatically set when you create a workspace. You can change this to another PadoGrid installation as needed. |
MOSQUITTO_HOME | Mosquitto home directory path. Overrides the default Mosquitto path set in RWE setenv.sh . The install_padogrid command installs Mosquitto source distributions, which must be manually compiled. To avoid this, you can install a Mosquitto binary yourself and include it in PATH instead. |
REDIS_HOME | Redis home directory path. Overrides the default Redis path set in RWE setenv.sh . |
SNAPPYDATA_HOME | SnappyData/ComputeDB home directory path. Overrides the default SnappyData path set in RWE setenv.sh . |
SPARK_HOME | Spark home directory path. Overrides the default Spark path set in RWE setenv.sh . |
initenv.sh
This file imports setenv.sh
to set the environment variables and enables bash command completion. The switch_workspace
command sources in this file to set the workspace environment variables. Do not modify this file.
.addonenv.sh
This hidden file sets the PADOGRID_WORKSPACE
environment variable to the workspace directory path. This is the single most important environment variable for managing workspaces. Do not modify this file.
Environment Variables | Default | Descriptions |
---|---|---|
PADOGRID_WORKSPACE | $PADOGRID_WORKSPACES_HOME/workspaces | Workspace directory path. |
CLUSTERS_DIR | $PADOGRID_WORKSPACE/clusters | Directory in which clusters are created and managed. |
PODS_DIR | $PADOGRID_WORKSPACE/pods | Directory in which pods are created and managed. |
APPS_DIR | $PADOGRID_WORKSPACE/apps | Directory in which apps are created and managed. |