- Overview
- Requirements
- Pre-installation
- Preparing the installation
- Downloading the installation packages
- Configuring the OCI-compliant registry
- Granting installation permissions with cluster roles
- Granting installation permissions without cluster roles
- Installing and configuring the service mesh
- Installing and configuring the GitOps tool
- Installing the External Secrets Operator
- Deploying Redis through OperatorHub
- Applying miscellaneous configurations
- Running uipathctl
- Installation
- Post-installation
- Accessing Automation Suite
- Managing the certificates
- Managing the cluster in ArgoCD
- Managing products
- Updating credentials
- Migration and upgrade
- Monitoring and alerting
- Cluster administration
- Product-specific configuration
- Orchestrator advanced configuration
- Configuring Orchestrator parameters
- Configuring appSettings
- Configuring the maximum request size
- Overriding cluster-level storage configuration
- Configuring NLog
- Saving robot logs to Elasticsearch
- Configuring credential stores
- Configuring encryption key per tenant
- Cleaning up the Orchestrator database
- Skipping host library installation
- AI Trust Layer
- Troubleshooting
- 500 errors and rate limiting on S3 requests in ODF
- External Secrets troubleshooting
- Configuring CSI driver tolerations for ODF 4.20
- Temporal as a Service troubleshooting
- AI Center and Document Understanding pods fail to start with TLS certificate verification enabled
- Studio Desktop cannot load Integration Service connectors and activities
- TLS certificate validation errors
- Manual ArgoCD NetworkPolicy mitigation (GHSA-47m3-95c7-g2g8)
- Configuring resource requests and limits for uipathctl-created workloads
Managing the cluster in ArgoCD
Manage Automation Suite cluster using ArgoCD GitOps workflows on OpenShift.
Overview
ArgoCD is a declarative, GitOps continuous delivery tool for Kubernetes. It is designed as a Kubernetes controller that continuously monitors UiPath® running applications and checks the current state against the desired target state as specified in the docker registry. For details, refer to ArgoCD documentation.
Administrators can have an overview of the cluster, configurations, applications status, and health, all via a simple UI or CLI. ArgoCD comes with its own open-source bundled Redis, which supports both HA and non-HA configurations.
Automation Suite uses ArgoCD in the following scenarios:
- Installing and upgrading the Fabric components and core UiPath® services.
- Automating the deployment of the desired application states in the specified target environments. ArgoCD follows the GitOps pattern of using Git/helm repositories as the source of truth for defining the desired application state.
- Keeping track of the installation state. If the installation failed at a specific point and you resume it after a while, ArgoCD skips all the steps that are already synced and resumes from the point where it failed.
- Self-healing the applications. If you mistakenly delete any of the objects, the manifests will automatically get synced.
ArgoCD read-only scenarios
You can use the ArgoCD account in the following read only scenarios:
- Visualizing all your apps, pods, and services in a simple interface
- Monitoring the health of all your apps, pods, and services
- Quickly identifying issues in your deployment
- Resyncing your application in your cluster
ArgoCD advanced scenarios
You must not modify any other settings or parameters except for the ones listed in this section.
You can use the ArgoCD admin account in the following advanced scenarios:
- Changing parameters for debugging purposes only; for instance, disabling self-healing;
- Deleting pods;
- Troubleshooting;
- Managing Orchestrator custom configuration; for instance, setting up encryption key per tenant;
- Updating the database connection strings;
- Syncing applications.
Note:
Make sure to refer to the proper UiPath® documentation before deleting or changing the advanced configuration on the UI.
Accessing ArgoCD
To log into your ArgoCD instance, follow the steps outlined in the scenario that applies to your specific case:
- If you have a dedicated ArgoCD instance, refer to Accessing the dedicated ArgoCD instance.
- If you use a shared ArgoCD instance, refer to Accessing the shared ArgoCD instance.