Skip to content

Commit d683252

Browse files
Merge pull request #9 from sunithasomanna/sprint-59-odim-6503
team feedback on aci readme
2 parents 51e05c7 + 8b51f48 commit d683252

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -139,12 +139,12 @@ Kubernetes cluster is set up and the resource aggregator is successfully deploye
139139
140140
- **odimPassword**: The encrypted password of the default administrator account of Resource Aggregator for ODIM. To generate the encrypted password, run the following command:
141141
142-
```
143-
echo -n '<HPE ODIMRA password>' |openssl pkeyutl -encrypt -inkey <odimCertsPath>/odimra_rsa.private -pkeyopt rsa_padding_mode:oaep -pkeyopt rsa_oaep_md:sha512|openssl base64 -A
144-
```
145-
142+
```
143+
echo -n '< ODIMRA password>' |openssl pkeyutl -encrypt -inkey <odimCertsPath>/odimra_rsa.private -pkeyopt rsa_padding_mode:oaep -pkeyopt rsa_oaep_md:sha512|openssl base64 -A
144+
```
145+
146146
Other parameters can have default values. Optionally, you can update them with values based on your requirements. For more information on each parameter, see [Plugin configuration parameters](#plugin-configuration-parameters).
147-
147+
148148
7. Generate the Helm package for the Cisco ACI plugin on the deployment node:
149149
150150
1. Navigate to `PluginCiscoACI/install/Kubernetes/helmcharts`.
@@ -164,12 +164,12 @@ Kubernetes cluster is set up and the resource aggregator is successfully deploye
164164
8. Save the Cisco ACI plugin Docker image on the deployment node at `~/plugins/aciplugin`.
165165
166166
```
167-
docker save aciplugin:3.0 -o ~/plugins/aciplugin/aciplugin.tar
167+
docker save aciplugin:3.1 -o ~/plugins/aciplugin/aciplugin.tar
168168
```
169169
170170
9. Navigate to the `PluginCiscoACI` directory.
171171
172-
```
172+
```
173173
cd ~/PluginCiscoACI
174174
```
175175
@@ -213,7 +213,7 @@ Kubernetes cluster is set up and the resource aggregator is successfully deploye
213213
odimraKafkaClientCertFQDNSan: aciplugin,aciplugin-events
214214
odimraServerCertFQDNSan: aciplugin,aciplugin-events
215215
216-
14. Move odimra_kafka_client.key, odimra_kafka_client.crt, odimra_server.key and odimra_server.crt stored in odimCertsPath to a different folder.
216+
14. Move `odimra_kafka_client.key`, `odimra_kafka_client.crt`, `odimra_server.key`, and `odimra_server.crt` stored in odimCertsPath to a different folder.
217217
218218
<blockquote> NOTE: odimCertsPath is the absolute path of the directory where certificates required by the services of Resource Aggregator for ODIM are present. This parameter is configured in the `kube_deploy_nodes.yaml` file.</blockquote>
219219
@@ -288,7 +288,7 @@ The plugin you want to add is successfully deployed.
288288
289289
| Parameter | Type | Description |
290290
| ---------------- | ----------------------- | ------------------------------------------------------------ |
291-
| HostName | String \(required\)<br> | It is the plugin service name and the port specified in the Kubernetes environment. For default plugin ports, see [Resource Aggregator for ODIM default ports](#resource-aggregator-for-odim-default-ports).<br>**NOTE**: If you are using a different port for a plugin, ensure that the port is greater than `45000`. |
291+
| HostName | String \(required\)<br> | It is the plugin service name and the port specified in the Kubernetes environment. For default plugin ports, see *[Resource Aggregator for ODIM default ports](#resource-aggregator-for-odim-default-ports)*.<br>**NOTE**: If you are using a different port for a plugin, ensure that the port is greater than `45000`. |
292292
| UserName | String \(required\)<br> | The plugin username. See default administrator account usernames of all the plugins in "Default plugin credentials". |
293293
| Password | String \(required\)<br> | The plugin password. See default administrator account passwords of all the plugins in "Default plugin credentials". |
294294
| ConnectionMethod | Array \(required\)<br> | Links to the connection methods that are used to communicate with this endpoint: `/redfish/v1/AggregationService/AggregationSources`.<br>**NOTE**: Ensure that the connection method information for the plugin you want to add is updated in the odim-controller configuration file.<br>To know which connection method to use, do the following:<br> 1. Perform HTTP `GET` on: `/redfish/v1/AggregationService/ConnectionMethods`.<br>You will receive a list of links to available connection methods.<br> 2. Perform HTTP `GET` on each link. Check the value of the `ConnectionMethodVariant` property in the JSON response. It displays the details of a plugin. Choose a connection method having the details of the plugin of your choice. For available connection method variants, see "Connection method variants" table.<br> |
@@ -335,7 +335,7 @@ The plugin you want to add is successfully deployed.
335335
336336
`/redfish/v1/Managers`
337337
338-
For more information, refer to "Adding a plugin" in the [Resource Aggregator for Open Distributed Infrastructure Management™ API Reference and User Guide](https://github.com/ODIM-Project/ODIM/tree/development/docs).
338+
For more information, see *Adding a plugin* in the *[Resource Aggregator for Open Distributed Infrastructure Management™ API Reference and User Guide](https://github.com/ODIM-Project/ODIM/tree/development/docs)*.
339339
340340
2. To verify that the added plugin is active and running, do the following:
341341
@@ -351,7 +351,7 @@ The plugin you want to add is successfully deployed.
351351
352352
2. To identify the plugin Id of the added plugin, perform HTTP `GET` on each manager link in the response.
353353
The JSON response body for a plugin manager has `Name` as the plugin name.
354-
Example:
354+
**Example**:
355355
The JSON response body for the Cisco ACI plugin manager has `Name` as `CiscoACI`.
356356
357357
**Sample response**
@@ -393,7 +393,7 @@ The plugin you want to add is successfully deployed.
393393
394394
- `Health` is `Ok`
395395
396-
For more information, refer to "Managers" in [Resource Aggregator for Open Distributed Infrastructure Management™ API Reference and User Guide](https://github.com/ODIM-Project/ODIM/tree/development/docs).
396+
For more information, refer to "Managers" in *[Resource Aggregator for Open Distributed Infrastructure Management™ API Reference and User Guide](https://github.com/ODIM-Project/ODIM/tree/development/docs)*.
397397
398398
399399

0 commit comments

Comments
 (0)