You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* added q3 changelog and how to get started
* added resources that were created with 2.2, broke out kubernetes and upgrading, added to workflows
* updating customizing docs
* formatting changes for customizng using chtl
* added sept changelog and audited created resources
* fixed duplicate line
* fixing link path
* reordering pages
title: Converting your HSF installation to use Kubernetes
3
3
description: As new enhancements are released by the Harness team, your installation will require updates to receive the new capabilities and templates. Additionally, there are some post-deployment tuning steps that will need to be done to adjust your implementation to suit your needs.
4
4
---
5
-
As new enhancements are released by the Harness team, your installation will require updates to receive the new capabilities and templates. Additionally, there are some post-deployment tuning steps that will need to be done to adjust your implementation to suit your needs.
6
-
7
-
## Upgrade your version of Harness Solutions Factory
8
-
9
-
1. Navigate to the `Solutions Factory` project within the `Harness Platform Management` organization of your Harness account
10
-
2. Run the pipeline `Mirror Harness Official solutions Factory Repos`
11
-
12
-
_**Note**: This pipeline will replicate the current released versions and changes from the Harness ISE team into your local repositories stored within your organization `Harness Platform Management`_
13
-
3. Run the pipeline `Manage Pilot Light` to implement the first phase of the update. This will update the core resources used by HSF
14
-
4. Run the pipeline `Deploy Solutions Factory` to finish the upgrade of the Solutions Factory engines.
15
-
5. Run the pipeline `Register IDP Templates` to synchronize the Harness Template Library workflows into your IDP installation
16
-
17
-
## Convert your HSF installation to use Kubernetes
18
5
19
6
1. Navigate to the `Solutions Factory` project within the `Harness Platform Management` organization of your Harness account
20
7
2. Open the `Infrastructure` module and choose `Workspaces`
21
8
3. Find and select the `Harness Pilot Light` workspace
22
9
4. Navigate to the `Variables` tab and choose `OpenTofu Variables`
23
-
5. Edit `kubernetes_connector` to provide an existing Kubernetes connector reference. _**Note**: The connector will need to be scoped to the correct location where the connector exists. Prefix with `account.` or `org.` depending on its location._
10
+
5. Edit `kubernetes_connector` to provide an existing Kubernetes connector reference.
11
+
_**Note**: The connector will need to be scoped to the correct location where the connector exists. Prefix with `account.` or `org.` depending on its location._
24
12
6. Optionally, edit `kubernetes_namespace` to modify the namespace into which the pods will be deployed.
25
13
26
14
_**Note**: Additional details around the various options and variables can be found in the `pilot-light` directory of the Harness Solutions Factory repository_
@@ -40,4 +28,4 @@ _**STOP**: Changing the Kubernetes connector in this workspace only modifies it
40
28
_**Note**: Additional details around the various options and variables can be found in the `solutions-factory` directory of the Harness Solutions Factory repository_
41
29
42
30
15. Navigate to pipelines
43
-
16. Run the pipeline `Deploy Solutions Factory` to apply the changes.
31
+
16. Run the pipeline `Deploy Solutions Factory` to apply the changes.
Copy file name to clipboardExpand all lines: kb/reference-architectures/hsf/created-resources.md
+17-6Lines changed: 17 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,10 @@ After HSF is deployed will have the following resources in your account:
10
10
A service account named `harness-platform-manager` is created at the account level. This service account has admin privileges and is responsible for provisioning and managing the resources necessary for running HSF workflows.
11
11
12
12
### Variables
13
-
To support IDP workflows, four account-level variables are also created. These variables store key configuration values, including the project name, organization name, connector information, and platform URL. They enable workflows to dynamically locate and interact with the correct components and environments within Harness.
13
+
To support IDP workflows, account-level variables are created. These variables store key configuration values, including the project name, organization name, connector information, and platform URL. They enable workflows to dynamically locate and interact with the correct components and environments within Harness. The variables created are `HARNESS_ENDPOINT`, `HARNESS_PORTAL_RESOURCES`, `custom_template_library_connector`, `custom_template_library_repo`, `solutions_factory_template_library_connector`, `solutions_factory_template_library_repo`, `solutions_factory_endpoint`, `solutions_factory_org`, and `solutions_factory_project`.
14
+
15
+
## Connectors
16
+
Connectors are created to integrate HSF with codebases and artifact repos. The connectors that are created are `harnessSecretManager` for both `Delegate Mangement` and `Image Factory` projects, `Custom_Harness_Template_Library_Repo`, `solutions_factory_template_library_connector`, `solutions_factory_template_library_repo`, `Harness_Solutions_Factory_Repo`, `Harness_Template_Library_Repo`, `Harness_Solutions_Factory_Repo___Official`, `harnessSecretManager`, `hsf_solutions_factory_connector`, `hsf_dockerhub_connector`, and `harnessSecretManager`.
14
17
15
18
### Organizations
16
19
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.
@@ -19,7 +22,7 @@ All HSF-related resources are organized under a newly created organization named
19
22
Within this organization, two user groups are established: `hsf-admin` and `hsf-user`. The `hsf-admin` group has organization admin privileges and is intended for platform administrators and users managing the implementation of HSF. The `hsf-user` group, by contrast, is granted organization viewer privileges and is designed for broader team access to view and use the workflows without elevated permissions.
20
23
21
24
### Secrets
22
-
Secrets are also created at the organization level to securely manage authentication and access credentials. The first, named `HSF Platform API Key`, stores the secret value associated with the harness-platform-manager service account. This key is managed by a pipeline that automatically handles rotation to maintain security best practices.
25
+
Secrets are also created at the organization level to securely manage authentication and access credentials. `HSF Platform API Key`, stores the secret value associated with the harness-platform-manager service account. This key is managed by a pipeline that automatically handles rotation to maintain security best practices. `hsf_harness_stub_secret_key` and `hsf_harness_stub_access_key` are also created.
23
26
24
27
### Projects
25
28
Several projects are initialized within the `harness-platform-management` organization.
@@ -32,11 +35,18 @@ The Solutions Factory project includes eight pipelines, each designed to perform
32
35
- The `Deploy Solutions Factory` pipeline handles additional configuration tasks related to setting up and managing the HSF deployment. It ensures that the target environment is properly initialized and ready to operate.
33
36
- 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.
34
37
- The `Register 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.
38
+
- The `Register Custom IDP Templates` pipeline automatically imports all available templates from the custom-harness-template-library and registers them into your IDP instance.
35
39
- The `Rotate HSF Token` pipeline handles secure token rotation for the harness-platform-manager service account.
36
40
- 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.
37
41
- 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.
38
-
- The `Provision Workspace` pipeline will be used for apply only executions and will be one of the pipelines that is separated out from Execute IACM Workspaces.
42
+
- The `Provision Workspace` pipeline plans and applies workflows (with built-in approvals).
39
43
- The `Execute IACM Workspaces` pipeline is responsible for executing the IACM workspace by applying the selected templates and provisioning the actual Harness resources defined within the workflow.
44
+
- The `Plan and Validate IACM Workspace` pipeline verifies Terraform code.
45
+
- The `Mirror Harnesss Official Solutions Factory Repos` pipeline mirrors the official repos and pulls in any new updates that we release to the code base.
46
+
- The `Execute Drift Analysis` pipeline identifies configuration drift from source code.
- The `Bulk Workspace Management` pipeline allows for bulk operations.
49
+
- The `Bulk Workspace IDP Registration` pipeline allows for backwards compatibility from older version to load older resources into IDP.
40
50
41
51
### Workspaces
42
52
Two IACM workspaces are created as part of the HSF framework:
@@ -45,6 +55,7 @@ Two IACM workspaces are created as part of the HSF framework:
45
55
46
56
### Repositories
47
57
There are three repositories included in the deployment and exist under the organization level. You can find them under Harness Platform Management (organization) → Solutions Factory (account) → Code Repository (module) → Repositories:
48
-
- The `harness-solutions-factory` repository houses all of the source code that is required to standup and run Harness Solutions Factory.
49
-
- The `harness-template-library` repository houses all of the scaffold and templates for how to manage Harness resources.
50
-
- The `harness-delegate-setup` repository serves as an example of how to build a custom Harness Delegate and automate the addition of tools into the delegate.
58
+
- 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.
59
+
- 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.
60
+
- The `harness-delegate-setup` repository serves as an example of how to build a custom Harness Delegate and automate the addition of tools into the delegate.
61
+
- The `custom-harness-template-library` repository houses customized templates created to support Harness entity management and provisioning.
Description: Configures the connectors for a centralized build farm configuration
24
+
25
+
### Deploy Harness SAST & SCA Templates
26
+
Description: Configures and deploys a series of templates for SCA and SAST scanners.
27
+
28
+
### Harness CI Image Factory
29
+
Description: The Harness CI Image Factory is a pipeline designed to mirror and replicate the lifecycle of images used by Harness CI module steps.
30
+
31
+
### Harness Delegate Image Factory
32
+
Description: The Harness Delegate Images Factory is a robust Harness pipeline designed to create and manage the lifecycle of customized Harness Delegate Images.
33
+
34
+
## Executing a Workflow
7
35
In order to deploy a workflow or look at the catalog to see what workflows are available go to IDP → Workflows.
8
36
9
37
<DocImage path={require('../static/hsf-execute-workflow-1.png')} title="Click to view full size image" />
Copy file name to clipboardExpand all lines: kb/reference-architectures/hsf/htl/configuring-stage-infra.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,7 @@
1
1
---
2
2
title: Configuring Stage Infrastructure
3
3
description: We have documented reusable code snippets that can be used for allowing user customization when writing pipeline template and Template workflows.
4
+
sidebar_position: 3
4
5
---
5
6
Within the Harness Platform, there are certain modules - CI, STO, IACM, or IDP - that require the user to configure infrastructure. When developing a pipeline with these modules a user must choose a build infrastructure type: Kubernetes or Cloud. We have documented reusable code snippets that can be used for allowing user customization when writing pipeline template and Template workflows.
0 commit comments