Skip to content

Commit

Permalink
Merge pull request #44 from MZC-CSC/develop
Browse files Browse the repository at this point in the history
Update with the latest version information for release
  • Loading branch information
MZC-CSC authored Nov 26, 2024
2 parents 9b75520 + 43d524d commit b7fd47f
Show file tree
Hide file tree
Showing 18 changed files with 2,544 additions and 1,244 deletions.
78 changes: 76 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,24 +97,98 @@ $ cd cm-mayfly
```

## 2. Prerequisites
Some subsystems require initial setup for configuration.
Some sub systems may require initial setup, including changing the default password. If changes or settings are needed, modify the information in the `./conf/docker` folder.

For example, to change the SMTP settings for cm-cicada, modify the following file:
`./conf/docker/conf/cm-cicada/airflow_smtp.env`

[For more details, refer to the cm-cicada SMTP configuration guide.](https://github.com/cloud-barista/cm-cicada?tab=readme-ov-file#smtp)

<!--
### mc-datamanager
The `mc-data-manager` subsystem `requires authentication information to use CSP`. Currently, only the configuration method using the `profile.json file` is supported. Therefore, if you wish to use mc-data-manager, `make sure to register the CSP-specific authentication information` in the `./conf/docker/conf/mc-data-manger/data/var/run/data-manager/profile/profile.json` file before setting up the infrastructure.
If necessary, you can also modify the contents of the profile.json file after the infrastructure has been set up.

-->

## 3. Building a Docker-based infrastructure
```
$ ./cm-mayfly infra run
```

If you do not want to see the output logs and want to run it in the background, you can use the `-d` option to run it in detach mode.
```
$ ./cm-mayfly infra run -d
```


## 4. Checking the subsystem running status
To verify that the Cloud-Migrator system is running correctly, use the `info` command to check the healthy status of each subsystem.
```
$ ./cm-mayfly infra info
```

For some subsystems, including cm-cicada, the order of startup is important. Even if they are marked as healthy, they may not be running correctly. For cm-cicada, please check the logs and restart if any errors occur.
```
$ ./cm-mayfly logs -s cm-cicada
```

Alternatively, you can use the web portal or Open API to check if the list of Task Components contains 10 items.
curl -s http://localhost:8083/cicada/task_component | jq '. | length'

If you determine that a restart is necessary, stop and then start it as shown below.
```
$ ./cm-mayfly infra stop -s cm-cicada
$ ./cm-mayfly infra run -s cm-cicada
```


## 5. Some helpful commands
If a new version of the Docker image is released, you can update the running version of Cloud-Migrator to the latest version using the `update` command.
```
$ ./cm-mayfly infra update
```

You can `update` a specific service using the `-s` flag.
```
$ ./cm-mayfly infra update -s cb-spider
```
```
$ ./cm-mayfly infra update -s "cb-spider cb-tumblebug"
```

You can check the logs of the entire system using the `logs` command.
```
$ ./cm-mayfly infra logs
```

You can `logs` a specific service using the `-s` flag.
```
$ ./cm-mayfly infra logs -s cb-spider
```
```
$ ./cm-mayfly infra logs -s "cb-spider cb-tumblebug"
```



You can `stop` a specific service using the `-s` flag.
```
$ ./cm-mayfly infra stop -s cb-spider
```
```
$ ./cm-mayfly infra stop -s "cb-spider cb-tumblebug"
```

You can `run` a specific service using the `-s` flag.
```
$ ./cm-mayfly infra run -s cb-spider
```
```
$ ./cm-mayfly infra run -s "cb-spider cb-tumblebug"
```



<!--
## docker-compose.yaml
Expand Down
Loading

0 comments on commit b7fd47f

Please sign in to comment.