Skip to content

Commit ea6d909

Browse files
authored
Merge pull request #19 from MZC-CSC/develop
update image version to related version
2 parents 53e0211 + 0811eab commit ea6d909

10 files changed

Lines changed: 2652 additions & 2497 deletions

File tree

README.md

Lines changed: 36 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,36 @@ If you have any difficulties in using mcc, please let us know.
1515

1616
## mcc Overview
1717
- Management tool that supports the installation, execution, status information provision, termination, and API calls of the M-CMP system.
18-
- Currently, only the Docker Compose mode is supported.
19-
- [Docker Compose mode](./docs/mcc-docker-compose-mode.md)
18+
- Currently, infra subcommand is only support docker compose base infra install and management.
19+
- [infra subcommand](./docs/mc-admin-cli-infra.md)
20+
- If you want to checkout how to run the whole subsystem on the single instance on CSP Instance, see [this document](./docs/mc-admin-cli-infra.md).
21+
22+
## Development & Test Environment
23+
- Go 1.23
24+
- Docker version 27.3.1
25+
- Docker Compose version v2.29
2026

2127
## Install Docker & Docker Compose V2
28+
2229
- [Install Docker Engine on Ubuntu](https://docs.docker.com/engine/install/ubuntu/)
23-
- Tested version: Docker version 24.0.7, build afdd53b
24-
- Tested version: Docker Compose version v2.21.0
30+
31+
checkout the commands down below.
32+
33+
```shell
34+
sudo apt-get install -y apt-transport-https ca-certificates curl gnupg-agent software-properties-common
35+
36+
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
37+
38+
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
39+
40+
sudo apt-get update
41+
42+
sudo apt-get install -y docker-ce docker-ce-cli docker-compose-plugin
43+
```
44+
45+
46+
47+
---
2548

2649
# Command to build the operator from souce code
2750
```Shell
@@ -34,7 +57,7 @@ mc-admin-cli/src$ go get -u
3457
(Build a binary for mcc)
3558
mc-admin-cli/src$ go build -o mcc
3659

37-
(Build a binary for mcc using Makerfile depends on your machine's os type)
60+
**Build a binary for mcc using Makerfile depends on your machine\'s os type**
3861
mc-admin-cli/src$ make
3962
mc-admin-cli/src$ make win
4063
mc-admin-cli/src$ make mac
@@ -55,7 +78,7 @@ Usage:
5578
5679
Available Commands:
5780
api Call the M-CMP system's Open APIs as services and actions
58-
docker A tool to operate M-CMP system
81+
infra A tool to operate M-CMP system
5982
help Help about any command
6083
rest rest api call
6184
@@ -66,7 +89,7 @@ Use "mcc [command] --help" for more information about a command.
6689
```
6790

6891
For more detailed explanations, see the articles below.
69-
- [docker sub-command guide](./docs/mc-admin-cli-docker-compose-mode.md)
92+
- [infra sub-command guide](./docs/mc-admin-cli-infra.md)
7093
- [rest sub-command guide](./docs/mc-admin-cli-rest.md)
7194

7295
## docker-compose.yaml
@@ -76,11 +99,11 @@ The necessary service information for the M-CMP System configuration is defined
7699
If you want to change the information for each container you want to deploy, modify the mc-admin-cli/docker-compose-mode-files/docker-compose.yaml file or use the -f option.
77100
```
78101

79-
## docker subcommand
80-
For more information, check out [the docker subcommand document.](./docs/mc-admin-cli-docker-compose-mode.md)
102+
## infra subcommand
103+
For more information, check out [the infra subcommand document.](./docs/mc-admin-cli-infra.md)
81104

82105

83-
For now, it supports docker's run/stop/info/pull/remove commands.
106+
For now, it supports infra's run/stop/info/pull/remove commands.
84107

85108
Use the -h option at the end of the sub-command requiring assistance, or executing 'mcc' without any options will display the help manual.
86109

@@ -98,13 +121,13 @@ Available Commands:
98121
stop Stop M-CMP System
99122
100123
Flags:
101-
-h, --help help for docker
124+
-h, --help help for infra
102125
103126
Use "mcc infra [command] --help" for more information about a command.
104127
```
105128

106129
## infra subcommand examples
107-
Simple usage examples for docker subcommand
130+
Simple usage examples for infra subcommand
108131
```
109132
- ./mcc infra pull [-f ../conf/docker/docker-compose.yaml]
110133
- ./mcc infra run [-f ../conf/docker/docker-compose.yaml] -d
@@ -114,7 +137,7 @@ Simple usage examples for docker subcommand
114137
115138
```
116139
## k8s subcommand
117-
K8S is not currently supported and will be supported in the near future.
140+
**K8S is not currently supported and will be supported in the near future.**
118141

119142
## rest subcommand
120143
The rest subcommands are developed around the basic features of REST to make it easy to use the open APIs of M-CMP-related frameworks from the CLI.

bin/mcc

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)