Skip to content

Commit c21efd4

Browse files
Update README.md
1 parent 47b46e3 commit c21efd4

File tree

1 file changed

+29
-26
lines changed

1 file changed

+29
-26
lines changed

README.md

Lines changed: 29 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,19 @@
22

33
The IBM Cloud Schematics Agents extends Schematics ability to reach your private, or on-premises, infrastructure. Integrate the Schematics Agents running in your private network to the IBM Cloud Schematics service to provision, configure, and operate your private or on-premise cloud cluster resources without any time, network, or software restrictions.
44

5-
This Agent repository helps users to provision the infrastructure required for an Agent and deploys the services on the provisioned infrastructure.
5+
This Agent repository helps you to provision the infrastructure required for an Agent and deploys the services on the provisioned infrastructure.
66

77
## Table of Contents
88

99
1. [Prerequisites](##Prerequisites)
1010
2. [Agents deployment](##Agents-Deployment)
11-
3. [Infrastructure](##Infrastructure)
12-
4. [Service](##Service)
13-
5. [Requirements](##Requirements)
14-
6. [Inputs](##Inputs)
15-
7. [Outputs](##Outputs)
16-
8. [Next Steps](##Next-Steps)
11+
3. [Using tar files](##Using-Tar-Files)
12+
4. [Infrastructure](##Infrastructure)
13+
5. [Service](##Service)
14+
6. [Terraform versions](##Terraform-Versions)
15+
7. [Inputs](##Inputs)
16+
8. [Outputs](##Outputs)
17+
9. [Next Steps](##Next-Steps)
1718

1819
## Prerequisites
1920

@@ -22,8 +23,13 @@ This Agent repository helps users to provision the infrastructure required for a
2223
3. Make sure that you have the [required IBM Cloud IAM permissions](https://cloud.ibm.com/docs/containers?topic=containers-access_reference) to create and work with IBM Cloud Cluster.
2324
4. Make sure that you have the [required IBM Cloud IAM permissions](https://cloud.ibm.com/docs/log-analysis?topic=log-analysis-iam) to create and work with IBM Log Analysis.
2425
5. Make sure that you have the [required IBM Cloud IAM permissions](https://cloud.ibm.com/docs/activity-tracker?topic=activity-tracker-iam) to create and work with IBM Activity tracker.
25-
6. The `Terraform` version should be `~> 1.0`.
26-
7. The `Terraform ibm provider` version should be `~> 1.42`.
26+
27+
## Terraform versions
28+
29+
| **Name** | **Version** |
30+
| --------------------------| -------------|
31+
| terraform | ~> 1.0 |
32+
| terraform_provider_ibm | ~> 1.42 |
2733

2834
## Agents deployment
2935

@@ -35,37 +41,34 @@ This repository has `.tf` configuration for the deployment of Agent infrastructu
3541
| └── service
3642
```
3743

44+
## Using tar files
45+
46+
The respository contains the solution templates in the form of `tar` files to install the `Agent infrastructure` and deploy the `Agent service`. Perform following steps to use the `tar` file.
47+
48+
- Download the `/templates/templates.zip` file to your local system.
49+
- From your terminal extract the content of `zip` file using the command. `unzip templates.zip`
50+
- The templates as TAR files should now be available as
51+
- The `agent-infrastructure-templates.tar` for setting up the VPC, IKS cluster, and LogDNA services infrastructure.
52+
- The `agent-service-templates.tar` to deploy the Agent service into your infrastructure.
53+
3854
## Infrastructure
3955

40-
This is an terraform configuration which provisions Agent Infrastructure on IBM Cloud.
41-
42-
A collection of services that will provisioned on IBM Cloud. Here are the list of services
56+
The `agent-infrastructure-templates.tar` is a Terraform configuration archive files which provisions Agent infrastructure on IBM Cloud. A collection of following services are provisioned.
4357
- VPC
4458
- IBM Kubernetes cluster
4559
- IBM Log Analysis
4660
- Activity Tracker
4761

48-
Link this repository to the Schematics Workspace and run `Generate Plan` and `Apply Plan` to create the Agent infrastructure.
62+
Click [here](https://cloud.ibm.com/docs/schematics?topic=schematics-agents-setup&interface=ui#agents-setup-infra-ui) to use the Agent infrastructure `tar` file. Link this repository to the Schematics Workspace and run `Generate Plan` and `Apply Plan` to create the Agent infrastructure.
4963

5064
## Service
5165

52-
This contains Terraform configuration which deploys Agent services on Infrastructure.
53-
54-
A collection of Agent-related microservices deployed on the Agent Infrastructure. It is composed of the following microservices
66+
The `agent-service-templates.tar` contains Terraform configuration which deploys Agent services on infrastructure. A collection of Agent related microservices deployed on the Agent infrastructure. It is composed of the following microservices
5567
- Sandbox
5668
- runtime-job
5769
- Job runner
5870

59-
Link this repository to the Schematics Workspace and run `Generate Plan` and `Apply Plan` to deploy the Agent services the agent infrastructure.
60-
61-
## Requirements
62-
63-
64-
| **Name** | **Version** |
65-
| --------------------------| -------------|
66-
| terraform | ~> 1.0 |
67-
| terraform_provider_ibm | ~> 1.42 |
68-
71+
Click [here](https://cloud.ibm.com/docs/schematics?topic=schematics-agents-setup&interface=ui#agents-setup-svc) to use the Agent service `tar` file. Link this repository to the Schematics Workspace and run `Generate Plan` and `Apply Plan` to deploy the Agent services the Agent infrastructure.
6972

7073
## Inputs
7174

0 commit comments

Comments
 (0)