Install Stork
You can install Stork with or without Portworx Enterprise using the following methods:
Deployment method without Portworx Enterprise
To install Stork version 23.9.1 on your Kubernetes cluster without installing Portworx Enterprise, run the below commands:
- Download the Stork deployment spec:
curl -fsL -o stork-spec.yaml "https://install.portworx.com/pxbackup?comp=stork&storkNonPx=true"
-
In the
stork-spec.yaml
, change the Stork version to 23.9.1 if the version differs. -
Apply the
stork-spec.yaml
to install the latest Stork version:
kubectl apply -f stork-spec.yaml
Deployment Method with Portworx Enterprise
If you have to install Stork 23.9.1 along with Portworx Enterprise, you can opt-in for Daemonset installation or Portworx Operator installation:
Portworx DaemonSet installation
To install Stork using Daemonset installation method:
- Fetch the Kubernetes version and then download
stork-spec.yaml
:
KBVER=$(kubectl version --short | awk -Fv '/Server Version: /{print $3}')
curl -fsL -o stork-spec.yaml "https://install.portworx.com/pxbackup?kbver=${KBVER}&comp=stork"
- Apply the
stork-spec.yaml
with the below command:
kubectl apply -f stork-spec.yaml
Portworx Operator installation
Stork fresh installation for Portworx Backup through user interface
If Stork is not installed as part of Portworx deployment, perform the following steps:
-
From the home page, click Add cluster.
-
Choose your Kubernetes platform.
-
Provide cluster name and Kubeconfig details.
-
Click Px-cluster to copy the stork installation command.
-
Run the Stork installation command.
If Stork is installed through PX Cluster option from the user interface in a namespace other than the namespace where Portworx Enterprise is deployed, perform Step 6 or else go to Step 7.
- Update the following key-value pairs in stork deployment's (
stork-spec.yaml
) environment variable section, using kubectl edit command.
kubectl edit deployment stork -n <stork-namespace>
env:
- name: PX_NAMESPACE
value: <portworx-deployed-namespace>
- name: PX_SERVICE_NAME
value: portworx-api
- name: STORK-NAMESPACE
value: portworx
- Click Add Cluster.
Updating Stork deployment for Portworx Backup through user interface
Perform the below steps to update Stork installation using Portworx operator option:
- Edit the stc (Kubernetes resource):
kubectl edit stc -n <portworx-deployed-namespace>
- Append the Stork image and version details in Stork section:
stork:
args:
webhook-controller: "true"
enabled: true
image: openstorage/stork:23.9.1 - Save and exit.
Stork install for air-gapped environments
If your application cluster is air-gapped, then you must pull the following images before installing Stork:
openstorage/cmdexecutor:23.9.1
openstorage/stork:23.9.1
openstorage/kopiaexecutor:1.2.10
openstorage/nfsexecutor:1.2.10
-
Push the above images to your internal registry server, accessible by the air-gapped nodes.
-
After pushing the images, follow the instructions in How to install Stork based on your deployment methods to install your stork version.