Quickstart Guide
Installation and Deployments
Kubernetes Installation
10min
you can use kubernetes to install manufacturing connect edge before you begin get access to a configured kubernetes cluster get access to persistentvolumeclaim (pvc) learn more about persistent volumes from the kubernetes documentation get administrative permissions to run the kubectl command line tool obtain access to a manufacturing connect edge service account json file, which you can get from mfgconnect\@litmus io depending on the specific requirements of your environment, you may need to get access to a storage class learn more about storage classes from the kubernetes documentation to use kubernetes to install manufacturing connect edge, you will need to do the following step 1 launch a manufacturing connect edge kubernetes step 2 log in to manufacturing connect edge to jump to a specific section, refer to the table of contents on the right side and click the corresponding step step 1 launch a manufacturing connect edge kubernetes to launch a manufacturing connect edge kubernetes 1\ request and download the service account json file by sending an email to mfgconnect\@litmus io 2\ open a command prompt terminal (ctrl+r) 3\ execute the following linux commands to setup credentials for a kubernetes namespace kubectl create namespace imc edge prodkubectl create namespace imc edge prod the command creates a namespace named imc edge prod kubectl create secret namespace imc edge prod docker registry imc credential docker server=us docker pkg dev docker username= json key docker password="$(cat /{file name} json)"# change sa file from string to base64 $encodedpassword = \[convert] tobase64string(\[text encoding] utf8 getbytes((get content raw \\\<file name> json))) \# step to add secret kubectl create secret docker registry imc credential namespace imc edge prod docker server=us docker pkg dev docker username= json key docker password="$encodedpassword" important if you encounter an error as shown in the screenshot below when using windows powershell, make sure to follow these steps the namespace has been created there are no spaces in the command replace the double quotes with single quotes refer to the command parameters kubectl create secret sets a secret for use with a docker registry namespace imc edge prod sets up a kubernetes namespace of imc edge prod docker registry imc credential sets up secret name as imc credential this should not be changed docker server=us docker pkg dev sets the docker registry server as us docker pkg dev this should not be changed docker username= json key sets the docker registry username to connect to the server above this should not be changed docker password="$(cat /\<file name> json)" retrieves the password within the service account file requested from step 1 note imc edge prod should be changed to an isolated namespace to suit deployment best example if the json file is named abc123 json , execute kubectl create secret namespace imc edge prod docker registry imc credential docker server=us docker pkg dev docker username= json key docker password="$(cat /abc123 json)" 4\ copy or download the following manufacturing connect edge deployment file https //archbee doc uploads s3 amazonaws com/ssuuxkzuk9bftepnn 6zo/fq8jua6kua30tai5zfw2e mc edge deployment yaml \# create serviceaccount apiversion v1 kind serviceaccount metadata name imc edge docker namespace imc edge prod labels app kubernetes io/name imc edge docker app kubernetes io/instance imc edge instance \ \# create pvc kind persistentvolumeclaim apiversion v1 metadata name imc edge data namespace imc edge prod labels app kubernetes io/name imc edge docker app kubernetes io/instance imc edge instance spec accessmodes \ "readwriteonce" resources requests storage "10g" \ \# create service apiversion v1 kind service metadata name imc edge docker namespace imc edge prod labels app kubernetes io/name imc edge docker app kubernetes io/instance imc edge instance spec type clusterip ports \ port 443 targetport https protocol tcp name https selector app kubernetes io/name imc edge docker app kubernetes io/instance imc edge instance \ \# create deployment apiversion apps/v1 kind deployment metadata name imc edge docker namespace imc edge prod labels app kubernetes io/name imc edge docker app kubernetes io/instance imc edge instance spec replicas 1 selector matchlabels app kubernetes io/name imc edge docker app kubernetes io/instance imc edge instance template metadata labels app kubernetes io/name imc edge docker app kubernetes io/instance imc edge instance spec serviceaccountname imc edge docker securitycontext {} imagepullsecrets \ name imc credential containers \ name imc edge docker securitycontext capabilities add \ net admin image "us docker pkg dev/litmus customer facing/imce build/mce\ latest" imagepullpolicy ifnotpresent ports \ name https containerport 443 protocol tcp volumemounts \ mountpath /var mountpropagation name imc edge data subpath subpathexpr resources requests cpu 1 memory 1024mi limits cpu 4 memory 4096mi volumes \ name imc edge data persistentvolumeclaim claimname imc edge data 5\ execute following command to deploy manufacturing connect edge kubernetes cluster using the deployment file from step 4 kubectl apply f mc edge deployment yaml namespace imc edge prodkubectl apply f mc edge deployment yaml namespace imc edge prod refer to the command parameters f mc edge deployment yaml uses the file mc edge deployment yaml for deployment this should not be changed namespace imc edge prod sets imc edge prod to be the deployment that kubernetes will use special and additional considerations manufacturing connect edge can function in both single/multi kubernetes node clusters, and can support various networking modes your kubernetes admin has the responsibility to configure proper networking adjust cpu/ram/storage for the kubernetes cluster as needed storage should be set to at least 10gb scale additional computing resources when using high computing power manufacturing connect edge features such as plc drivers, cc, and flows consult kubernetes official documentation https //kubernetes io/docs/home/ for best practices ensure credentials are stored properly with kubernetes management net admin permissions are required step 2 log in to manufacturing connect edge see access the manufacturing connect edge web ui docid\ o3ekdp0z j7ithaal0mwi for details on logging in see access the terminal user interface docid\ qshf w5zqofde xozajrh for instructions on how to navigate and log in for the first time note to identify the port configured by the admin, use the following command kubectl get svc n imc edge prod