Skip to content

Commit ca6c8ee

Browse files
Ashley KimHarness
authored andcommitted
edited hsf content for clarity and removed what is no longer needed (#101195)
* c6ff57 Apply suggestion from code review * ccb4ff edited hsf documentation * b6224a updated for hub support and removed content that is no longer needed
1 parent f3ef6ac commit ca6c8ee

File tree

10 files changed

+57
-59
lines changed

10 files changed

+57
-59
lines changed

docs/harness-solutions-factory/content/upgrade/2-3-upgrade.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,9 @@
2727
| hsf_idp_resource_mgr_image | harnesssolutionfactory/harness-idp-resource-manager:latest |
2828
| hsf_iacm_manager_plugin | harnesssolutionfactory/harness-manage-iacm-workspace:latest |
2929
| enable_hsf_mini_factory | false |
30-
1. Save Changes
30+
| should_use_hsf_hub | false |
31+
| should_use_harness_idp | true |
32+
- Save Changes
3133
6. Run `Deploy Solutions Factory`
3234
7. If you’re doing an upgrade from pre 2.2 run `Bulk Workspace IDP Registration`
33-
8. Run `Register Official IDP Templates` to get all the new templates from `harness-template-library`
34-
9. The upgrade is now complete!
35+
8. The upgrade is now complete!

docs/harness-solutions-factory/content/upgrade/pr-upgrade.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,15 @@ Starting from HSF 2.2.5 you will get a pull request notification email when a ne
3333
6. Run `Manage Pilot Light` → Approve Changes (Review) → Approve Now
3434
<DocImage path={require('../../static/PR-upgrade7.png')} title="Click to view full size image" />
3535

36+
6. Go into IaCM Workspaces → `Harness Solutions Factory`
37+
- Go into Connectors and Variables and add the variables:
38+
| Variable Key | Value |
39+
| --- | --- |
40+
| should_use_hsf_hub | false |
41+
| should_use_harness_idp | true |
42+
- Save Changes
43+
3644
7. Wait for `Manage Pilot Light` to finish and then run `Deploy Solutions Factory`
3745
<DocImage path={require('../../static/PR-upgrade8.png')} title="Click to view full size image" />
3846

39-
**Refresh IDP Workflows**
40-
41-
8. Because we updated `harness-template-library` run `Register Official IDP Templates`
42-
<DocImage path={require('../../static/PR-upgrade9.png')} title="Click to view full size image" />
43-
44-
9. Update is complete!
47+
8. Update is complete!

docs/harness-solutions-factory/faq.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ HSF is provided as a no-additional cost solution delivered as part of an existin
2525
</details>
2626

2727
<details>
28-
<summary>Do I have to purchase HSF? Is there a cost associated with HSF?</summary>
28+
<summary>What modules do I need for HSF?</summary>
2929

30-
No, you do not need to purchase IaCM or IDP modules to use HSF, but you can only use the modules to manage the Harness Platform.
30+
HSF leverages Harness Internal Developer Portal, Infrastructure as Code Management and Harness Code Repository. You do not need to purchase additional modules specifically for HSF. If you do not have IDP, IaCM or HCR licensed, we will provide you a limited license in order to use HSF and manage Harness entities.
3131
</details>
3232

3333
---
@@ -86,4 +86,10 @@ Harness Solutions Factory supports integration with all **OpenTofu** versions<Ha
8686
parse='.[-1] | " (latest: v\(.))"'></HarnessApiData>.
8787

8888
Due to licensing and legal limitations all legacy Terraform versions under the MPL license are supported (up to **1.5.x**), any BSL versions (from 1.6.0) are not supported.
89+
</details>
90+
91+
<details>
92+
<summary>Can HSF manage cloud resources, not just Harness entities? </summary>
93+
94+
Yes. Because HSF is built on OpenTofu and IaCM, it can provision any resource that has a Terraform provider — AWS, Azure, GCP, etc. However, you will need a paid enterprise license for IDP and IaCM if provisioning non Harness entites.
8995
</details>

docs/harness-solutions-factory/new-to-hsf/get-started.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,24 @@ sidebar_position: 20
77

88
Welcome to the HSF onboarding guide. Discover how Harness accelerates onboarding and adoption by reducing setup time and maintaining best practices
99

10-
## Pre Deployment of HSF
11-
### Prerequisites
10+
## Prerequisites
1211

13-
Before beginning, ensure you have:
12+
Before HSF can be deployed, confirm the following:
1413

15-
- Access to a Harness Account
16-
- Ability to create an admin level token
14+
- Your Harness account has the IDP and IaCM modules enabled.
15+
- Harness Code Repository is enabled on the account.
16+
- You have an account with admin-level permissions, or can coordinate with someone who does to generate a temporary Personal Access Token (PAT).
17+
- No account-level OPA policies are in place that would block pipeline execution.
1718

1819
If you do not meet all these prerequisites but think your organization could benefit from HSF, please reach out to your Harness account team.
1920

2021
## Post Deployment of HSF
21-
Now that HSF has been deployed, what’s next? Below are a couple things to get you started using Harness Solutions Factory:
22+
After deployment, complete the following steps to configure your account and verify the installation.
2223

2324
- Create Organizations and Projects. [This lab](../hands-on-labs/getting-started-lab.md) goes over some details.
2425
- Add users to the HSF Admin, HSF Users (account level) and HSF Mirror Reviewers (organization level) groups
25-
- This can be bound to SSO Provider Groups
26-
- Decide on the notification preferences for HSF Admins (Slack, Email, Teams)
26+
- This can be bound to [SSO Provider Groups](https://developer.harness.io/docs/platform/authentication/single-sign-on-saml/)
27+
- Decide on the [notification preferences](https://developer.harness.io/docs/platform/role-based-access-control/add-user-groups#edit-notification-preferences) for HSF Admins (Slack, Email, Teams)
2728
- You can also change the mirror schedule by going into Harness Pilot Light and finding the `mirror_schedule` variable
2829
- Change token configurations
2930
- You can change the rotation schedule or if it should rotate on a schedule by going into Harness Pilot Light and finding the `should_rotate_on_schedule` and `rotation_schedule` variables

docs/harness-solutions-factory/new-to-hsf/hsf-upgrade.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import DynamicMarkdownSelector from '@site/src/components/DynamicMarkdownSelecto
1010
We are constantly adding new features and functionality to Harness Solutions Factory. Below are the detailed steps on how to upgrade to the latest!
1111

1212
<DynamicMarkdownSelector
13+
defaultOption="PR Process Upgrade"
1314
options={{
1415
"PR Process Upgrade": {
1516
path: "/harness-solutions-factory/content/upgrade/pr-upgrade.md",

docs/harness-solutions-factory/new-to-hsf/overview.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,17 @@ redirect_from:
77
- /kb/reference-architectures/hsf/overview
88
---
99

10-
Harness Solutions Factory (HSF) is a scalable automation framework designed to help organizations rapidly deploy and manage **Harness resources** through **self-service workflows**, **governance**, and **best practices** — all out of the box.
11-
12-
Whether you’re enabling new teams, setting up golden templates, or driving adoption of Harness at scale, HSF provides a repeatable, governed foundation to help you get started faster and stay standardized across your organization.
10+
Harness Solutions Factory (HSF) is an automation framework that deploys and manages Harness platform resources through self-service workflows, governed templates, and Infrastructure as Code. It gives platform engineering teams a repeatable foundation for onboarding teams to Harness at scale, without requiring each team to configure their own pipelines, projects, or environments from scratch.
1311

1412
### Key Capabilities
15-
- **Self-Service Enablement:** Empower development teams to deploy their own Harness resources using guided workflows — no YAML editing or pipeline scripting required.
16-
- **Governance by Design:** Enforce organizational standards automatically through reusable templates and pre-approved configurations.
17-
- **Accelerated Time to Value:** Reduce setup from days or weeks to minutes using out-of-the-box automation.
18-
- **Continuous Standardization:** Ensure all Harness resources stay aligned with best practices.
13+
- **Self-service workflows:** Development teams can request Harness resources — projects, pipelines, environments — through IDP workflow. No direct platform or Terraform knowledge is required.
14+
- **IaC-backed governance:** Every resource HSF creates is backed by a Terraform workspace in IaCM. Changes go through plan-and-approve cycles, and drift is surfaced in the IDP catalog.
15+
- **Out-of-the-box templates:** HSF ships with pre-built templates for common platform operations: project setup, CI pipeline onboarding, security scanning, build farm configuration, and delegate management.
16+
- **Managed updates:** When Harness releases new versions of HSF, a scheduled pipeline creates a pull request in your custom template library. You review and merge on your timeline — nothing auto-applies.
1917

2018
## Core Concepts
2119
### 1. Self-Service Workflows
22-
Workflows are the user-facing automation steps in HSF.
23-
24-
These guided processes help teams create, configure, and deploy new Harness resources — such as projects, pipelines, and repositories — following approved standards.
20+
Workflows are the user-facing entry point to HSF. A user selects a workflow in IDP, fills out some details, and submits. HSF then triggers a pipeline that creates the requested resource, registers it in the IDP catalog, and optionally gates on an approval before applying the changes. Users can watch the execution in real time and access outputs directly from the catalog entry once provisioning is complete.
2521

2622
Example workflows include:
2723

@@ -30,7 +26,7 @@ Example workflows include:
3026
- **Deploy Harness CI Golden Standard Templates**
3127

3228
### 2. Harness Template Library
33-
Harness Template Library houses all the templates that are created by Harness. They reflect best practices validated by our Center of Excellence (CoE) and implementation engineering team. These templates serve as the foundation for all workflows created through HSF.
29+
Harness Template Library houses all the templates that are created by Harness. They reflect best practices validated by the Harness Center of Excellence (CoE) and implementation engineering team. These templates serve as the foundation for all workflows created through HSF.
3430

3531
This repository is stored in Harness Code Repository and is copied over locally when you first deploy HSF.
3632

-308 KB
Binary file not shown.

docs/harness-solutions-factory/use-hsf/created-resources.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ To support IDP workflows, account-level variables are created. These variables s
3131

3232
All HSF-related resources are organized under a newly created organization named `Harness Platform Management`. This organization serves as the central location for all projects, configurations, and access controls associated with the HSF deployment.
3333

34+
HSF is intentionally isolated into its own organization rather than placed inside an existing one so that platform-level management concerns stay separate from everything else in your Harness account. This also makes RBAC cleaner — HSF Admins can have org-admin rights scoped to this organization.
35+
3436
**User Groups**
3537

3638
Within the `Harness Platform Management` organization, two user groups are created at the account level: 
@@ -60,7 +62,6 @@ The Solutions Factory project includes sixteen pipelines, each designed to perfo
6062
- The `Manage Pilot Light` pipeline applies updates and changes to the core HSF framework. It is used to maintain and evolve the foundational infrastructure that supports the overall platform.
6163
- The `Mirror Harness Official Solutions Factory Repository` pipeline is responsible for cloning and copying data from the official HSF repository into your target Harness account. It also manages the synchronization of updates during future releases, effectively keeping your local copy aligned with the source of truth.
6264
- The `Unpack Solutions Factory` pipeline unpacks the Solutions Factory.
63-
- The `Register Official IDP Templates` pipeline automatically imports all available templates from the harness-template-library and registers them into your IDP instance. This ensures that your IDP has access to the full suite of templates required to power self-service workflows.
6465
- The `Register Custom IDP Templates` pipeline automatically imports all available templates from the custom-harness-template-library and registers them into your IDP instance.
6566
- The `Rotate HSF Token` pipeline handles secure token rotation for the `harness-platform-manager` service account.
6667
- The `Create and Manage IACM Workspaces` pipeline is invoked at the start of each workflow execution. It provisions and manages IACM workspaces, ensuring that the required infrastructure is in place before any resource provisioning begins. It also registers resources in IDP.
@@ -86,4 +87,4 @@ There are three repositories included in the deployment and exist under the orga
8687

8788
- The `harness-solutions-factory` repository houses all of the source code that is required to standup and run Harness Solutions Factory. A code branch rule called `harness_solutions_factory_codeowners` is created in this repository.
8889
- The `harness-template-library` repository houses all of the scaffold and templates for how to manage Harness resources. A code branch rule called `harness_solutions_factory_codeowners` is created in this repository.
89-
- The `custom-harness-template-library` repository houses customized templates created to support Harness entity management and provisioning.
90+
- The `custom-harness-template-library` repository houses customized templates created to support Harness entity management and provisioning. It is created via a point in time mirror of `harness-template-library` when your instance of HSF is deployed.

docs/harness-solutions-factory/use-hsf/hsf-hub.md

Lines changed: 9 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -28,38 +28,21 @@ With HSF Hub, we changed how permissions are implemented since we no longer coul
2828
- A role called `Shared_Resource_Access` which allows access to shared resources in the project such as secrets and templates
2929
- And a resource group for each of the HSF Hub pipelines. By combining a role and resource group you are able to control which pipelines a user can run.
3030

31-
### Operating Modes
32-
33-
With the creation of HSF Hub, HSF 2.4 introduces the concept of operating modes. The different operating modes allows usage of HSF with and without Harness IDP.
34-
35-
HSF Core are the core 12 pipelines of Harness Solutions Factory
36-
37-
#### *HSF Core + Harness IDP*
38-
39-
This operating model is the traditional model and the only one that has been supported till now. It leverages Harness IDP features to execute workflows, run pipeline stages and control RBAC.
40-
41-
#### *HSF Core + HSF Hub*
42-
43-
This operating model is new with HSF 2.4. Removing the dependency on Harness IDP, HSF Hub is a new project that gets created to house all of the best practice templates from Custom Template Library. It runs a chained pipeline from this project and is controlled by ABAC.
44-
45-
#### *HSF Core + Backstage (or BYO API Connector)*
46-
47-
This operating model is new with HSF 2.4. It allows you to bring your own form of Backstage or API to trigger a HSF Core pipeline.
48-
4931
### Changing Operating Modes to use HSF Hub
5032

5133
Since HSF Hub was created starting version 2.4 you will need to make sure that you are on 2.4 or later. If you need help updating please refer back to this document.
5234

53-
1. Navigate to the Harness Solutions Factory workspace in the Solutions Factory project.
54-
2. Go into the Connectors and Variables tab and scroll down to find the `should_use_harness_idp` and `should_use_hsf_hub` variable.
55-
<DocImage path={require('../static/hsfhub.png')} title="Click to view full size image" />
56-
3. Change the variable value to use/not use IDP and use/not use HSF Hub
57-
4. Navigate to pipelines and run Deploy Solutions Factory
35+
1. Navigate to the Harness Pilot Light workspace in the Solutions Factory project.
36+
2. Go into the Connectors and Variables tab and scroll down to find the `should_use_harness_idp` and set it to false.
37+
3. Click provision and wait till it's completed. Verify that the HSF Core Manager is created.
38+
4. Navigate to the Solutions Factory Workspace and add in the variables `should_use_hsf_hub` set to true and `should_use_harness_idp` set to true.
39+
5. Click provision. This will remove the IDP pipelines and change the Create and Manage IaCM pipeline to use IaCM steps.
40+
6. Navigate to pipelines and run Deploy Solutions Factory.
5841

5942
If you are upgrading from a version prior to 2.4 you will also need to update your templates because HSF Hub now points to Custom Template Library instead of Harness Template Library
6043

61-
1. Pull in example files for the specific templates that you are using
62-
2. Add in customized inputs and additional variables
63-
3. Run Deploy HSF Hub
44+
1. Pull in example files for the specific templates that you are using.
45+
2. Add in customized inputs and additional variables.
46+
3. Run Deploy HSF Hub.
6447

6548
Deploy HSF Hub is a pipeline that will be created when the `should_use_hsf_hub` variable is set to true. This pipeline will clone the Custom Harness Template Library repository and use the hub registration file to parse through the resources to create the pipelines that live inside the HSF Hub project. These pipelines can be customized with pre and post steps, role bindings and resource groups.

docs/harness-solutions-factory/use-hsf/workflows.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,14 @@ sidebar_position: 2
55
redirect_from:
66
- /kb/reference-architectures/hsf/hsf-workflows
77
---
8+
When workflows are triggered, it creates an IaCM workspace to create and manage the resources. A workspace maps to a single Terraform state file. If you don't want to maintain ongoing state, there is an option to create ephemeral workspaces. Workspaces for platform-level resources (creating orgs, projects, connectors) live inside the Solutions Factory project.
9+
10+
By default, approval notifications are sent by email to members of the HSF Admins group. If your team uses Microsoft Teams or Slack, this can be reconfigured in the notification settings on the user group. There are two distinct approvals — one before entity creation and one before the Terraform plan is applied. The IaCM plan approval shows the resource diff so the approver can see exactly what will change before confirming.
11+
12+
After a workflow completes, the outputs are pushed directly into the IDP catalog entry for that workspace.
13+
814
## Default Workflows
9-
These are the workflows that are automatically created when HSF is deployed into your account. These workflows are created by `harness-template-library` repository and registered into IDP via the `Register Official IDP Templates` pipeline:
15+
Below are the workflows that are automatically created when HSF is deployed into your account. These workflows are created by `harness-template-library` repository and registered into IDP via the `Register Custom IDP Templates` pipeline.
1016

1117
### Harness Organization Setup
1218
Harness Organization Setup is a workflow that creates and manages organizations within your Harness account. It standardizes the process for requesting new organizations and provides an easy way to manage them consistently. The workflow provisions an organization with a defined name.

0 commit comments

Comments
 (0)