Skip to content

Commit 35d4462

Browse files
authored
Merge pull request #696 from euconnor/issue-666
Issue 666 - move file, other minor updates
2 parents 0283a15 + a8a52ca commit 35d4462

3 files changed

Lines changed: 21 additions & 19 deletions

File tree

common-requests/use.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ years: 2020 - 2026
44
layout: page
55
title: "How to use Open Horizon"
66
description: "Basic instructions and examples for using the Open Horizon projects CLI"
7-
lastupdated: 2026-03-27
7+
lastupdated: 2026-03-30
88
parent: Quick Start
99
nav_order: 2
1010
---
@@ -133,7 +133,7 @@ After you see the `agreement_execution_start_time` value, you can run `docker ps
133133

134134
To use the exchange communication commands, set up two environment variables.
135135

136-
### Pre-requisite
136+
### Prerequisite
137137

138138
You need information from the All-in-One installation summary message that was displayed when you installed the {{site.data.keyword.mgmt_hub}}, agent, and CLI. This message begins with `----------- Summary of what was done:` and includes several generated passwords and tokens.
139139

@@ -144,7 +144,7 @@ export HZN_ORG_ID=myorg
144144
export HZN_EXCHANGE_USER_AUTH=admin:[User org admin user generated password]
145145
```
146146

147-
> Now, you should be able to connect to the exchange with the CLI.
147+
Now, you can connect to the exchange by using the CLI.
148148

149149
Use `hzn exchange status` or `hzn exchange node list` to confirm that it works with no errors. Additionally, `hzn exchange user list` displays the user account that you are currently using and if it is authenticated successfully.
150150

docs/getting_started/faq.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ copyright: Contributors to the Open Horizon project
33
years: 2020 - 2026
44
title: FAQs
55
description: Documentation for Frequently asked questions
6-
lastupdated: 2026-03-27
6+
lastupdated: 2026-03-30
77
nav_order: 1
88
parent: Help and Support
99
---
@@ -43,7 +43,7 @@ The following are answers to some frequently asked questions (FAQs) about {{site
4343

4444
You can install the open source {{site.data.keyword.mgmt_hub}} (without the {{site.data.keyword.ieam}} management console) with the All-in-One installer for developers. The All-in-One installer creates a complete but minimal {{site.data.keyword.mgmt_hub}}, not suitable for production use. It also configures an example edge node. This tool enables open source component developers to get started quickly without the time it takes to configure a complete production {{site.data.keyword.ieam}} {{site.data.keyword.mgmt_hub}}. For information about the All-in-One installer, see [{{site.data.keyword.ieam}} - Devops ](https://github.com/open-horizon/devops/tree/master/mgmt-hub){:target="_blank"}{: .externalLink} GitHub repository.
4545

46-
The All-in-One installer publishes a default set of example services during deployment. You can customize which sample services are published by setting the `BYO_SAMPLES` environment variable to point to a text file containing GitHub URLs of your own service repositories. This enables you to test and develop with your own custom services in addition to the default examples. For detailed instructions, see the [Using Custom Sample Services ](https://github.com/open-horizon/devops/tree/master/mgmt-hub#using-custom-samples){:target="_blank"}{: .externalLink} section in the {{site.data.keyword.mgmt_hub}} documentation.
46+
The All-in-One installer publishes a default set of sample services during deployment. You can customize which sample services are published by setting the `BYO_SAMPLES` environment variable to point to a text file that contains GitHub URLs of your own service repositories. This enables you to test and develop with your own custom services in addition to the default samples. For detailed instructions, see the [Using Custom Sample Services](../hub/custom_samples.md).
4747

4848
## Is {{site.data.keyword.ieam}} software open-sourced?
4949
{: #open_sourced}
Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,20 @@ years: 2026
44
layout: page
55
title: "Using custom sample services"
66
description: "How to publish your own sample services with the All-in-One Management Hub"
7-
lastupdated: 2026-03-27
7+
lastupdated: 2026-03-30
88
parent: Quick Start
99
nav_order: 3
10+
parent: Installing Management hub
11+
grand_parent: Management Hub
1012
---
1113

1214
# Using custom sample services
1315

14-
The {{site.data.keyword.ieam}} All-in-One {{site.data.keyword.mgmt_hub}} deployment includes a set of default example services that demonstrate edge computing capabilities. You can extend this by publishing your own custom sample services during the deployment process.
16+
The {{site.data.keyword.ieam}} All-in-One {{site.data.keyword.mgmt_hub}} deployment includes a set of default sample services that demonstrate edge computing capabilities. You can extend this by publishing your own custom sample services during the deployment process.
1517

1618
## Overview
1719

18-
The Bring Your Own (BYO) Samples feature allows you to specify additional service repositories that are published to the Exchange during the All-in-One deployment. This is useful for:
20+
You can specify additional service repositories that are published to the Exchange during the All-in-One deployment. This is useful for:
1921

2022
- Testing your own edge services in a development environment
2123
- Demonstrating custom solutions to stakeholders
@@ -31,7 +33,7 @@ When you set the `BYO_SAMPLES` environment variable, the deployment script:
3133
3. Publishes the service definition, service policy, and deployment policy to the Exchange
3234
4. Makes the services available for deployment to edge nodes
3335

34-
Your custom samples are published in addition to the default {{site.data.keyword.ieam}} example services (CPU, GPS, and Hello World).
36+
Your custom samples are published in addition to the default {{site.data.keyword.ieam}} sample services (CPU, GPS, and Hello World).
3537

3638
## Prerequisites
3739

@@ -42,13 +44,13 @@ Before using custom samples, ensure that:
4244
- `publish-service`: Publishes the service definition
4345
- `publish-service-policy`: Publishes the service policy
4446
- `publish-deployment-policy`: Publishes the deployment policy
45-
- Services are compatible with your target edge node architecture (AMD64, ARM, etc.)
47+
- Services are compatible with your target edge node architecture (AMD64, ARM, and so on.)
4648

4749
## Step-by-step instructions
4850

4951
### 1. Create a samples file
5052

51-
Create a text file containing the GitHub URLs of your service repositories, one per line:
53+
Create a text file that contains the GitHub URLs of your service repositories. Each URL must be on a separate line. For example:
5254

5355
```text
5456
https://github.com/open-horizon/open-horizon-services/tree/main/web-helloworld-python
@@ -57,27 +59,27 @@ https://github.com/your-organization/another-service
5759
```
5860
{: codeblock}
5961

60-
Save this file (for example, as `my-samples.txt`) in a location accessible during deployment.
62+
Save this file (for example, as `samples.txt`) in a location that is accessible during deployment.
6163

6264
### 2. Set the environment variable
6365

64-
Before running the deployment script, export the `BYO_SAMPLES` variable:
66+
Before you run the deployment script, export the `BYO_SAMPLES` variable:
6567

6668
```bash
67-
export BYO_SAMPLES=my-samples.txt
69+
export BYO_SAMPLES=samples.txt
6870
```
6971
{: codeblock}
7072

7173
### 3. Run the deployment
7274

73-
Run the All-in-One deployment script as usual:
75+
Run the All-in-One deployment script:
7476

7577
```bash
7678
curl -sSL https://raw.githubusercontent.com/open-horizon/devops/master/mgmt-hub/deploy-mgmt-hub.sh | bash
7779
```
7880
{: codeblock}
7981

80-
The script automatically detects the `BYO_SAMPLES` variable and publishes your custom services along with the default examples.
82+
The script automatically detects the `BYO_SAMPLES` variable and publishes your custom services with the default samples.
8183

8284
### 4. Verify the deployment
8385

@@ -90,9 +92,9 @@ hzn exchange service list
9092
```
9193
{: codeblock}
9294

93-
You should see your custom services listed along with the default IBM examples.
95+
Verify that your custom services are listed along with the default samples.
9496

95-
## Example service repository structure
97+
## Sample service repository structure
9698

9799
Your service repository must follow this structure:
98100

@@ -109,4 +111,4 @@ your-service/
109111
└── ... (your service code)
110112
```
111113

112-
The Makefile must include the `publish-only` target that calls the individual publish targets.
114+
The Makefile must include the `publish-only` target that calls the individual publish targets.

0 commit comments

Comments
 (0)