Skip to content

Commit ee0a1f4

Browse files
committed
update README
1 parent 7c06189 commit ee0a1f4

1 file changed

Lines changed: 63 additions & 0 deletions

File tree

README.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,69 @@ SPDX-License-Identifier: Apache-2.0
66

77
# Simapp
88
## Sim subscription app for Aether
9+
10+
## Repository Structure
11+
12+
Below is a high-level view of the repository and its main components:
13+
```
14+
.
15+
├── config # Contains configuration files for the Simapp service, such as runtime parameters and behavior definitions (simapp.yaml).
16+
│   └── simapp.yaml
17+
├── Dockerfile
18+
├── Dockerfile.fast
19+
├── go.mod
20+
├── go.mod.license
21+
├── go.sum
22+
├── go.sum.license
23+
├── LICENSES
24+
│   └── Apache-2.0.txt
25+
├── logger # Provides the logging setup and configuration used across the application.
26+
│   └── logger.go
27+
├── Makefile # Provides commands for building, testing, and cleaning up the project.
28+
├── README.md
29+
├── simapp.go # Main entry point of the Simapp service. Initializes the simulator, loads configuration, and starts execution.
30+
├── Taskfile.yml # Provides commands for building, testing, and cleaning up the project.
31+
├── test-mirror.txt
32+
├── VERSION
33+
└── VERSION.license
34+
35+
4 directories, 16 files
36+
```
37+
38+
39+
## Configuration and Deployment
40+
41+
**Docker**
42+
43+
To build the container image:
44+
```
45+
task mod-start
46+
task build
47+
task docker-build-fast
48+
```
49+
50+
**Kubernetes**
51+
52+
The standard deployment uses Helm charts from the Aether project. The version of the Chart can be found in the OnRamp repository in the `vars/main.yml` file.
53+
54+
55+
## Quick Navigation
56+
57+
| Type | File / Directory | Description |
58+
| ---------------- | --------------------------------------------------------------------- | --------------------------------------------------- |
59+
| Core | [`simapp.go`](./simapp.go) | Main source file for launching the Simapp service. |
60+
| Configuration | [`config/simapp.yaml`](./config/simapp.yaml) | Defines simulation behavior and runtime parameters. |
61+
| Logging | [`logger/logger.go`](./logger/logger.go) | Centralized logging configuration. |
62+
| Container | [`Dockerfile`](./Dockerfile) / [`Dockerfile.fast`](./Dockerfile.fast) | Standard and optimized Docker build definitions. |
63+
| Build Tools | [`Makefile`](./Makefile) / [`Taskfile.yml`](./Taskfile.yml) | Build and automation scripts. |
64+
| Dependencies | [`go.mod`](./go.mod) / [`go.sum`](./go.sum) | Go module definitions and dependency checksums. |
65+
| License | [`LICENSES/Apache-2.0.txt`](./LICENSES/Apache-2.0.txt) | License file for open-source compliance. |
66+
| Version | [`VERSION`](./VERSION) | Specifies the component version. |
67+
| Documentation | [`README.md`](./README.md) | Repository-level documentation and usage notes. |
68+
69+
70+
71+
972
### Subscriber Configuration
1073
- SIMApp can configure devices in 5G as well as in 4G.
1174
- look for config/simapp.yaml file for all override options

0 commit comments

Comments
 (0)