Get Started With HSF Post Deployment
Onboarding guide for HSF
If you haven't been through deployment yet or have questions about getting started, reach out to your Harness account team.
Before you begin
Confirm the following with your Harness account team before working through this guide:
HSF has been successfully deployed to your account.
The Harness Platform Management organization is visible in your account.
You have been added to the HSF Admins group, which gives you the permissions needed to complete the steps below.
Create organizations and projects
Set up the organizational structure your teams will use within Harness. This includes creating the orgs and projects that HSF workflows will provision resources into.
For a walkthrough of how organizations and projects work in Harness, go to Organizations and projects.
Why this matters: HSF workflows provision resources into specific orgs and projects. Getting this structure right before running your first workflow saves reorganization work later.
Add users to HSF groups
Add your team members to the appropriate groups based on their role:
HSF Admins
Account
Platform engineers managing the HSF implementation. This group approves workflow changes and receives email notifications for pending approvals.
HSF Users
Account
Developers and teams who will submit and monitor workflows via IDP.
HSF Mirror Reviewers
Organization
Anyone responsible for reviewing and merging PRs when new HSF versions are released.
Configure notifications for HSF Admins
HSF Admins receive notifications when workflow approvals are pending. Choose the notification channel that works best for your team.
Supported channels: Slack, Email, Microsoft Teams
Navigate to Account Settings, then select Access Control.
Select User Groups, then select HSF Admins.
Under Notification Preferences, click +Channel.
Select your channel and enter its details:
Slack: the Slack channel incoming webhook URL.
Email/Alias: the group email addresses that receive notifications.
Microsoft Teams: the Microsoft Teams incoming webhook URL.
Click Test to confirm the channel details are valid, then click Apply.
Go to Manage user groups to review the full list of notification channels and their settings.
Review token configuration
HSF creates a one-year token for the harness-platform-manager service account with automatic weekly rotation enabled by default.
To change the rotation behavior, navigate to the Harness Pilot Light workspace and update the following variables:
should_rotate_on_schedule
Whether the token rotates automatically on a schedule.
true
rotation_schedule
Cron expression for the rotation schedule.
Weekly, Sundays at 03:00
After changing either variable, run Manage Pilot Light to apply the update.
Configure the mirror schedule (optional)
By default, HSF checks for new releases from Harness on a set schedule and creates a pull request when a new version is available.
To change the schedule, navigate to the Harness Pilot Light workspace and update the mirror_schedule variable. After updating, run Manage Pilot Light to apply the change.
Move Custom Template Library to your own SCM (optional)
By default, Custom Template Library is hosted in Harness Code Repository. If your team prefers to manage it in an external SCM (GitHub, GitLab, Bitbucket), update the following account-level variables:
custom_template_library_connector
Connector reference for your SCM
custom_template_library_repo
URL of the repo in your SCM
For instructions on setting up a code repository connector, go to Connect to a Git repository.
Configure your container registry
By default, HSF uses an organization-level connector (hsf_dockerhub_connector) to pull images from DockerHub using anonymous authentication. Anonymous DockerHub pulls are rate limited. Add credentials to this connector before running any workflows to avoid pipeline failures.
To add credentials to the DockerHub connector, navigate to Harness Platform Management → Connectors → hsf_dockerhub_connector and update the authentication settings.
Using a different container registry?
If your organization uses a private registry (Nexus, Artifactory, ECR, etc.), update the following:
Change the
hsf_pipeline_connector_refaccount variable to point to your registry connector.If using Nexus or Artifactory, ensure you use the fully qualified image path for all images, including the registry hostname.
Configure Kubernetes execution (optional)
By default, HSF pipelines run on Harness Cloud infrastructure. To run pipelines on your own Kubernetes cluster, go to Convert your HSF installation to use Kubernetes.
Verify your installation
Once you have completed the steps above, confirm everything is working:
Next steps
Run your first workflow: execute an IDP workflow end to end and verify the output.
Customize a workflow: modify a default workflow using Custom Template Library.
Upgrade HSF: how to pull and apply new HSF releases when they are available.
Last updated
Was this helpful?