|
45 | 45 |
|
46 | 46 | This command will modify the directory to create the necessary files for a |
47 | 47 | charm operator package. By default it will work in the current directory. |
48 | | -It will setup the following tree of files and directories: |
| 48 | +
|
| 49 | +Available profiles are: |
| 50 | + simple: |
| 51 | + A basic kubernetes charm with lot of texts helping the developer |
| 52 | + to navigate their first charm by following the instructions. |
| 53 | + kubernetes: |
| 54 | + A basic Kubernetes charm with exmaple container. |
| 55 | + machine: |
| 56 | + A basic charm but meant to be deployed in machine-based environments, |
| 57 | + without container requirements. |
| 58 | +
|
| 59 | +Depending on the profile choice, Charmcraft will setup the following tree of |
| 60 | +files and directories: |
49 | 61 |
|
50 | 62 | . |
51 | 63 | ├── charmcraft.yaml - Charm build configuration |
52 | 64 | ├── config.yaml - Config schema for your operator |
53 | | - ├── CONTRIBUTING.md - Instructions for how to build and develop your charm |
| 65 | + ├── CONTRIBUTING.md - Instructions for how to build and develop |
| 66 | + │ your charm |
54 | 67 | ├── LICENSE - Your charm license, we recommend Apache 2 |
55 | 68 | ├── metadata.yaml - Charm operator package description |
56 | | - ├── pyproject.toml - Configuration for testing, formatting and linting tools |
| 69 | + ├── pyproject.toml - Configuration for testing, formatting and |
| 70 | + │ linting tools |
57 | 71 | ├── README.md - Frontpage for your charmhub.io/charm/ |
58 | 72 | ├── requirements.txt - PyPI dependencies for your charm, with `ops` |
59 | 73 | ├── src |
@@ -117,8 +131,7 @@ def fill_parser(self, parser): |
117 | 131 | "--profile", |
118 | 132 | choices=list(PROFILES), |
119 | 133 | default=DEFAULT_PROFILE, |
120 | | - help=f"""Use the specified project profile (defaults to '{DEFAULT_PROFILE}', """ |
121 | | - f"""could be one of {', '.join(f"'{p}'" for p in PROFILES)})""", |
| 134 | + help=f"Use the specified project profile (defaults to '{DEFAULT_PROFILE}')", |
122 | 135 | ) |
123 | 136 |
|
124 | 137 | def run(self, args): |
|
0 commit comments