Skip to content

Commit bae7442

Browse files
LiliumCandidumPaola Nicosia
andauthored
fix(sofware caralog): miactl commands (#2109)
* fix(sofware caralog): miactl commands * mini fix --------- Co-authored-by: Paola Nicosia <[email protected]>
1 parent 80b0760 commit bae7442

File tree

4 files changed

+16
-16
lines changed

4 files changed

+16
-16
lines changed

docs/console/tutorials/visualize-infrastructure-project-components-runtime-data-in-console.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ runtime-data:
5858
- miactl context auth ci-auth --client-id "$CLIENT_ID" --client-secret "$CLIENT_SECRET"
5959
- miactl context set console --endpoint $CONSOLE --company-id $COMPANY_ID --auth-name ci-auth
6060
- miactl context use console
61-
- miactl marketplace apply --company-id=$COMPANY_ID -f runtime_manifest.json
61+
- miactl catalog apply --company-id=$COMPANY_ID -f runtime_manifest.json
6262
```
6363
6464
<details>

docs/software-catalog/items-management/miactl.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: miactl
44
sidebar_label: miactl
55
---
66

7-
One of the possible ways to interact with the Catalog is through [`miactl`](/cli/miactl/10_overview.md), the Mia-Platform Command Line Interface.
7+
One of the possible ways to interact with the Catalog is through [`miactl`](/cli/miactl/10_overview.md), the Mia-Platform Command Line Interface.
88

99
:::tip
1010
Before getting started, make sure you have completed the [setup guide](/cli/miactl/20_setup.md).
@@ -75,7 +75,7 @@ The idea behind the automation of the managing process is to leverage a CI/CD to
7575

7676
Any CI/CD tool will do the trick, but in this example we will focus on a Gitlab pipeline.
7777

78-
First of all, you need to create a **service account** on the Console, using, for example, the [Client Secret Basic authentication](/development_suite/identity-and-access-management/manage-service-accounts.md#adding-a-service-account).
78+
First of all, you need to create a **service account** on the Console, using, for example, the [Client Secret Basic authentication](/development_suite/identity-and-access-management/manage-service-accounts.md#adding-a-service-account).
7979

8080
With the account in place, create a `CLIENT_ID` and a `CLIENT_SECRET` [Gitlab CI/CD Variable](https://docs.gitlab.com/ee/ci/variables/) in your project and set the respective `client-id` and `client-secret` values you obtained during the setup of the service account.
8181

@@ -111,7 +111,7 @@ apply-catalog:
111111
- miactl context auth new-auth --client-id $CLIENT_ID --client-secret $CLIENT_SECRET
112112
- miactl context set new-context --company-id $COMPANY_ID --endpoint $CONSOLE_ENDPOINT --auth-name new-auth
113113
- miactl context use new-context
114-
- miactl marketplace apply -f ./items
114+
- miactl catalog apply -f ./items
115115

116116
rules:
117117
- if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
@@ -139,4 +139,4 @@ In this way, even users without the permission to manage the Catalog directly ca
139139

140140
When deleting an item or an item's version from the Catalog, keep in mind that you need to work both on the repository and on the Catalog itself, since a declarative approach usually works only in addition (i.e., deleting a manifest from the repository will not remove the item from the Catalog).
141141

142-
Therefore, remove the manifest from Git and use the `miactl marketplace delete` command to clean the Catalog.
142+
Therefore, remove the manifest from Git and use the `miactl catalog delete` command to clean the Catalog.

docs/software-catalog/tutorials/service-template-integrated-with-jenkins.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Marketplace service templates can be configured to be built using Jenkins, this
2020
We are going to create the service template in the Marketplace using `miactl` and link a git repository containing the Jenkins pipeline template:
2121

2222
- Create the marketplace resource object and save it in `jenkins-service-template.yaml`
23-
23+
2424
```yaml
2525
tenantId: <TENANT_ID>
2626
type: template
@@ -76,7 +76,7 @@ We are going to create the service template in the Marketplace using `miactl` an
7676
- Apply the resource using `miactl`
7777

7878
```sh
79-
miactl marketplace apply -f jenkins-service-template.yaml
79+
miactl catalog apply -f jenkins-service-template.yaml
8080
```
8181

8282
- In the linked repository create the Jenkins pipeline template at `services/node.xml`, this will instruct Jenkins to build the service when a new commit is pushed to the repository and run the
@@ -199,15 +199,15 @@ pipeline as defined in the linked `Jenkinsfile`. This template will be interpola
199199
- `mia_template_service_name_placeholder` name of the service, as specified in the Project
200200
- `mia_template_project_id_placeholder` the identifier of the Project
201201
- `mia_template_image_name_placeholder` the image name of the service, as specified in the Project
202-
- `%CUSTOM_PLUGIN_PROJECT_NAME%` name of the Project
202+
- `%CUSTOM_PLUGIN_PROJECT_NAME%` name of the Project
203203
- `%CUSTOM_PLUGIN_SERVICE_DESCRIPTION%` service description
204204
- `%CUSTOM_PLUGIN_CREATOR_USERNAME%` username of the user who created the service
205205
- `%CUSTOM_PLUGIN_PROJECT_FULL_PATH%` the full path of the Project in the Git provider
206206
- `%GIT_PROVIDER_BASE_URL%` the base URL of the Git provider hosting the service repository
207207
- `%GIT_PROVIDER_GROUP%` the group of service repository
208208
- `%GIT_PROVIDER_PROJECT%` the name of the service repository
209209
- `%CUSTOM_PLUGIN_PROJECT_GIT_PATH%` the full path of the service repository
210-
- `%NEXUS_HOSTNAME%` registry hostname
210+
- `%NEXUS_HOSTNAME%` registry hostname
211211
- `%SECRET_TOKEN%`secret token used to trigger the pipeline
212212

213213
- create the build pipeline definition `Jenkinsfile`

docs/software-catalog/tutorials/software-catalog.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ For a detailed explanation of the required metadata please refere to [this guide
5757
5. `Name` that is the name of the service
5858
6. `Description`
5959
7. `Repository Url` which is the url to the source code of the service
60-
8. `Docker Image`
60+
8. `Docker Image`
6161

6262
:::caution
6363
The `Asstes` object have a different spec based on the `Item Type` the exaple provided in this guide is related to the components of item `plugin`
@@ -122,7 +122,7 @@ For reference this is the `Assets` object configuration for an hypothetical plug
122122
```
123123

124124
:::caution
125-
The `componentId` and `name` fields must be equal.
125+
The `componentId` and `name` fields must be equal.
126126
:::
127127

128128
1. **Complete the process** – Follow the on-screen instructions, then save and submit the item to add it to the Catalog.
@@ -136,7 +136,7 @@ Using `miactl` requires setting up the CLI beforehand. For more details, refer t
136136
:::
137137

138138
:::info
139-
For testing purpose you can use your own account to create context and log-in the Mia-Platform Console using miactl.
139+
For testing purpose you can use your own account to create context and log-in the Mia-Platform Console using miactl.
140140
For production purpose the use of a `Service Account` with the `Company Owner` permission is recommended. To know more about service accounts follow this [documentation page](/development_suite/identity-and-access-management/manage-service-accounts.md).
141141
:::
142142

@@ -199,7 +199,7 @@ Once the `manifest.json` is ready, the following commands are needed to release
199199
> miactl context auth miactl-bot --client-id $CLIENT_ID --client-secret $CLIENT_SECRET
200200
> miactl context set my-context --company-id $COMPANY_ID --endpoint $CONSOLE_URL --auth-name miactl-bot
201201
> miactl context use my-context
202-
> miactl marketplace apply -f ./manifest.json
202+
> miactl catalog apply -f ./manifest.json
203203

204204
```
205205

@@ -232,17 +232,17 @@ First of all, download and save the latest version of the item configuration:
232232

233233
```bash
234234

235-
> miactl marketplace get ITEM_ID > myAwesomeService.json
235+
> miactl catalog get --item-id ITEM_ID --version VERSION > myAwesomeService.json
236236

237237
```
238238

239-
If you don't know the item id, use the `miactl marketplace list` command to list all the Catalog items.
239+
If you don't know the item id and/or the version, use the `miactl catalog list` command to list all the Catalog items.
240240

241241
Once you have the manifest, modify the fields you need and the publish the new version using the following command:
242242

243243
```bash
244244

245-
> miactl marketplace apply -f myAwesomeService.json
245+
> miactl catalog apply -f myAwesomeService.json
246246

247247
```
248248

0 commit comments

Comments
 (0)