Update README with installation instructions and add .gitignore for IDE files
Helm Chart CI & Release / Lint Helm Chart (push) Successful in 9s
Helm Chart CI & Release / Semantic Release (push) Successful in 10s

- Enhanced README.md with additional installation steps and a new image.
- Added .gitignore file to exclude IDE-specific files and directories.
This commit is contained in:
2026-02-19 20:59:37 +00:00
parent a44aef5381
commit e535a75649
3 changed files with 16 additions and 2 deletions
Generated Vendored
+8
View File
@@ -0,0 +1,8 @@
# Default ignored files
/shelf/
/workspace.xml
# Editor-based HTTP Client requests
/httpRequests/
# Datasource local storage ignored files
/dataSources/
/dataSources.local.xml
+8 -2
View File
@@ -23,6 +23,8 @@ make verify
make port-forward make port-forward
``` ```
## Installation ## Installation
### 1. Create local cluster ### 1. Create local cluster
@@ -63,6 +65,10 @@ make port-forward FLEET_PORT=9090
Open **https://localhost:8585** in your browser (accept the self-signed certificate). Open **https://localhost:8585** in your browser (accept the self-signed certificate).
Fleet setup wizard will guide you through initial configuration. Fleet setup wizard will guide you through initial configuration.
![1771534082840](image/README/1771534082840.png)
## Teardown ## Teardown
```bash ```bash
@@ -83,7 +89,7 @@ Verification checklist:
| Component | Check | | Component | Check |
| ----------- | ----------------------------------------------------------------- | | ----------- | ----------------------------------------------------------------- |
| **FleetDM** | Pods running; `make port-forward` → https://localhost:8585 | | **FleetDM** | Pods running; `make port-forward` → https://localhost:8585 |
| **MySQL** | `fleetdm-stack-mysql` service; Fleet connects and runs migrations | | **MySQL** | `fleetdm-stack-mysql` service; Fleet connects and runs migrations |
| **Redis** | `fleetdm-stack-redis-master` service; Fleet uses it for cache | | **Redis** | `fleetdm-stack-redis-master` service; Fleet uses it for cache |
@@ -162,5 +168,5 @@ tech-task/
The architectural design document for "Company Inc." is in `docs/`: The architectural design document for "Company Inc." is in `docs/`:
- [Architecture Design Document](docs/architecture-design-company-inc.md) — 12 page design (convert to PDF for submission) - [Architecture Design Document](docs/architecture-design-company-inc.md) — 1-2 page design (convert to PDF for submission)
- [High-Level Diagram](docs/architecture-hld.md) — Mermaid diagrams (infra, CI/CD, network security) - [High-Level Diagram](docs/architecture-hld.md) — Mermaid diagrams (infra, CI/CD, network security)
Binary file not shown.

After

Width:  |  Height:  |  Size: 161 KiB