indraq_cli 2.4.0 → 2.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG_v2.5.0.md +67 -0
- package/CHANGELOG_v2.6.0.md +9 -0
- package/LICENSE +21 -21
- package/README.md +422 -605
- package/RELEASE_CHECKS_v2.5.0.md +93 -0
- package/TEST_RESULTS_v2.5.0.txt +46 -0
- package/TEST_RESULTS_v2.6.0.txt +16 -0
- package/cloud-api/.dockerignore +18 -18
- package/cloud-api/.env.example +14 -14
- package/cloud-api/.indraq/project.json +4 -0
- package/cloud-api/Dockerfile +19 -19
- package/cloud-api/README.md +3 -3
- package/cloud-api/dist/index.js +57 -7
- package/cloud-api/dist/index.js.map +1 -0
- package/cloud-api/package.json +1 -1
- package/cloud-api/sql/001_init.sql +8 -8
- package/cloud-api/sql/002_user_providers_and_project_resources.sql +40 -40
- package/cloud-api/sql/003_environment_infrastructure.sql +19 -19
- package/cloud-api/sql/004_managed_aws_credentials.sql +20 -20
- package/cloud-api/sql/005_project_members_and_resource_grants.sql +22 -22
- package/cloud-api/sql/006_catalog_identity_password_security.sql +96 -96
- package/cloud-api/sql/007_aws_access_key_rotation.sql +16 -16
- package/cloud-api/sql/008_provider_scopes.sql +91 -91
- package/cloud-api/src/index.ts +50 -6
- package/cloud-api/tsconfig.json +18 -18
- package/dist/cli/doctor.command.js +1 -1
- package/dist/cli/doctor.command.js.map +1 -1
- package/dist/cli/help-content.d.ts.map +1 -1
- package/dist/cli/help-content.js +19 -18
- package/dist/cli/help-content.js.map +1 -1
- package/dist/modules/access/commands/access.command.js +34 -34
- package/dist/modules/access/commands/access.command.js.map +1 -1
- package/dist/modules/aws/commands/dns.command.d.ts.map +1 -1
- package/dist/modules/aws/commands/dns.command.js +3 -2
- package/dist/modules/aws/commands/dns.command.js.map +1 -1
- package/dist/modules/cloud/commands/cloud.command.d.ts +3 -0
- package/dist/modules/cloud/commands/cloud.command.d.ts.map +1 -1
- package/dist/modules/cloud/commands/cloud.command.js +121 -34
- package/dist/modules/cloud/commands/cloud.command.js.map +1 -1
- package/dist/modules/cloud/commands/environment.command.js +1 -1
- package/dist/modules/cloud/commands/environment.command.js.map +1 -1
- package/dist/modules/cloud/commands/provider.command.js +1 -1
- package/dist/modules/cloud/commands/provider.command.js.map +1 -1
- package/dist/modules/cloud/index.js +2 -2
- package/dist/modules/cloud/index.js.map +1 -1
- package/dist/modules/cloud/services/cloud-aws.service.d.ts +1 -1
- package/dist/modules/cloud/services/cloud-aws.service.d.ts.map +1 -1
- package/dist/modules/cloud/services/cloud-aws.service.js +2 -2
- package/dist/modules/cloud/services/cloud-aws.service.js.map +1 -1
- package/dist/modules/cloud/services/cloud-ghcr.service.js +2 -2
- package/dist/modules/cloud/services/cloud-ghcr.service.js.map +1 -1
- package/dist/modules/cloud/services/cloud-jenkins.service.d.ts +1 -1
- package/dist/modules/cloud/services/cloud-jenkins.service.d.ts.map +1 -1
- package/dist/modules/cloud/services/cloud-jenkins.service.js +157 -33
- package/dist/modules/cloud/services/cloud-jenkins.service.js.map +1 -1
- package/dist/modules/cloud/services/cloud-npm.service.d.ts +1 -1
- package/dist/modules/cloud/services/cloud-npm.service.d.ts.map +1 -1
- package/dist/modules/cloud/services/cloud-npm.service.js +2 -2
- package/dist/modules/cloud/services/cloud-npm.service.js.map +1 -1
- package/dist/modules/cloud/services/project-cleanup.service.d.ts +24 -0
- package/dist/modules/cloud/services/project-cleanup.service.d.ts.map +1 -0
- package/dist/modules/cloud/services/project-cleanup.service.js +141 -0
- package/dist/modules/cloud/services/project-cleanup.service.js.map +1 -0
- package/dist/modules/cloud/services/user-provider.service.d.ts +1 -1
- package/dist/modules/cloud/services/user-provider.service.d.ts.map +1 -1
- package/dist/modules/cloud/services/user-provider.service.js +3 -3
- package/dist/modules/cloud/services/user-provider.service.js.map +1 -1
- package/dist/modules/configure/configure.command.js +6 -4
- package/dist/modules/configure/configure.command.js.map +1 -1
- package/dist/modules/deploy/commands/build.command.d.ts.map +1 -1
- package/dist/modules/deploy/commands/build.command.js +23 -12
- package/dist/modules/deploy/commands/build.command.js.map +1 -1
- package/dist/modules/deploy/commands/configure-docker.command.js +6 -6
- package/dist/modules/deploy/commands/configure-docker.command.js.map +1 -1
- package/dist/modules/deploy/config/docker-config.js +1 -1
- package/dist/modules/deploy/config/docker-config.js.map +1 -1
- package/dist/modules/deploy/index.js +1 -1
- package/dist/modules/deploy/index.js.map +1 -1
- package/dist/modules/deploy/services/docker.service.js +1 -1
- package/dist/modules/deploy/services/docker.service.js.map +1 -1
- package/dist/modules/dockerfile/services/project-docker.service.d.ts +9 -0
- package/dist/modules/dockerfile/services/project-docker.service.d.ts.map +1 -0
- package/dist/modules/dockerfile/services/project-docker.service.js +122 -0
- package/dist/modules/dockerfile/services/project-docker.service.js.map +1 -0
- package/dist/modules/jenkins/commands/create-deployment.command.js +4 -4
- package/dist/modules/jenkins/commands/create-deployment.command.js.map +1 -1
- package/dist/modules/jenkins/index.js +1 -1
- package/dist/modules/jenkins/index.js.map +1 -1
- package/dist/modules/mobile/commands/mobile-environment.command.js +1 -1
- package/dist/modules/mobile/commands/mobile-environment.command.js.map +1 -1
- package/dist/modules/mobile/commands/mobile-prebuild.command.js +1 -1
- package/dist/modules/mobile/commands/mobile-prebuild.command.js.map +1 -1
- package/dist/modules/mobile/commands/ota.command.js +3 -3
- package/dist/modules/mobile/commands/ota.command.js.map +1 -1
- package/dist/modules/mobile/index.d.ts.map +1 -1
- package/dist/modules/mobile/index.js +8 -7
- package/dist/modules/mobile/index.js.map +1 -1
- package/dist/modules/mobile/services/mobile-project-directory.d.ts +3 -0
- package/dist/modules/mobile/services/mobile-project-directory.d.ts.map +1 -0
- package/dist/modules/mobile/services/mobile-project-directory.js +31 -0
- package/dist/modules/mobile/services/mobile-project-directory.js.map +1 -0
- package/dist/modules/mobile/services/ota-setup.service.d.ts.map +1 -1
- package/dist/modules/mobile/services/ota-setup.service.js +5 -3
- package/dist/modules/mobile/services/ota-setup.service.js.map +1 -1
- package/dist/modules/prebuild/commands/prebuild.command.d.ts +4 -0
- package/dist/modules/prebuild/commands/prebuild.command.d.ts.map +1 -1
- package/dist/modules/prebuild/commands/prebuild.command.js +155 -100
- package/dist/modules/prebuild/commands/prebuild.command.js.map +1 -1
- package/dist/modules/prebuild/index.js +2 -2
- package/dist/modules/prebuild/index.js.map +1 -1
- package/dist/modules/prebuild/setup-plan.d.ts +11 -0
- package/dist/modules/prebuild/setup-plan.d.ts.map +1 -0
- package/dist/modules/prebuild/setup-plan.js +58 -0
- package/dist/modules/prebuild/setup-plan.js.map +1 -0
- package/dist/modules/proxy/services/npm-api.service.d.ts +1 -0
- package/dist/modules/proxy/services/npm-api.service.d.ts.map +1 -1
- package/dist/modules/proxy/services/npm-api.service.js +1 -0
- package/dist/modules/proxy/services/npm-api.service.js.map +1 -1
- package/dist/modules/scaffold/commands/init.command.d.ts.map +1 -1
- package/dist/modules/scaffold/commands/init.command.js +33 -18
- package/dist/modules/scaffold/commands/init.command.js.map +1 -1
- package/dist/modules/scaffold/types.d.ts +3 -1
- package/dist/modules/scaffold/types.d.ts.map +1 -1
- package/dist/modules/scopes/commands/scope.command.d.ts +3 -1
- package/dist/modules/scopes/commands/scope.command.d.ts.map +1 -1
- package/dist/modules/scopes/commands/scope.command.js +15 -8
- package/dist/modules/scopes/commands/scope.command.js.map +1 -1
- package/dist/modules/scopes/index.js +1 -1
- package/dist/modules/scopes/index.js.map +1 -1
- package/dist/modules/scopes/services/scope-native.service.d.ts.map +1 -1
- package/dist/modules/scopes/services/scope-native.service.js +16 -5
- package/dist/modules/scopes/services/scope-native.service.js.map +1 -1
- package/dist/modules/setup/commands/setup.command.d.ts.map +1 -1
- package/dist/modules/setup/commands/setup.command.js +41 -24
- package/dist/modules/setup/commands/setup.command.js.map +1 -1
- package/dist/modules/users/commands/user.command.d.ts.map +1 -1
- package/dist/modules/users/commands/user.command.js +10 -2
- package/dist/modules/users/commands/user.command.js.map +1 -1
- package/dist/modules/users/providers/jenkins-user.provider.js +95 -95
- package/dist/modules/users/providers/npm-user.provider.d.ts.map +1 -1
- package/dist/modules/users/providers/npm-user.provider.js +31 -2
- package/dist/modules/users/providers/npm-user.provider.js.map +1 -1
- package/dist/shared/config/config-files.js +7 -7
- package/dist/shared/jenkins/role-strategy-groovy.js +84 -84
- package/dist/shared/process/run-npx.d.ts +4 -0
- package/dist/shared/process/run-npx.d.ts.map +1 -0
- package/dist/shared/process/run-npx.js +31 -0
- package/dist/shared/process/run-npx.js.map +1 -0
- package/docs/ARCHITECTURE.md +7 -7
- package/docs/CREATE-DEPLOYMENT-reference.groovy +8 -8
- package/docs/README_v2.6.0_DETAILED.md +1021 -0
- package/package.json +12 -5
- package/templates/jenkins/CREATE-DEPLOYMENT.groovy +8 -8
- package/templates/jenkins/Jenkinsfile-Mobile-App +759 -759
package/README.md
CHANGED
|
@@ -1,889 +1,706 @@
|
|
|
1
|
-
|
|
2
|
-
<img src="docs/assets/indraq-logo.png" alt="IndraQ" width="360" />
|
|
1
|
+
# IndraQ CLI v2.6.0
|
|
3
2
|
|
|
4
|
-
|
|
3
|
+
IndraQ CLI helps our team set up, build and deploy web and mobile apps.
|
|
5
4
|
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-

|
|
9
|
-

|
|
10
|
-

|
|
11
|
-

|
|
12
|
-
|
|
13
|
-
**[Quick start](#quick-start)** · **[Scopes](#provider-scopes)** · **[Users](#users-and-permissions)** · **[Projects](#projects-and-environments)** · **[Deploy](#prebuild-and-deploy)** · **[Commands](#command-reference)**
|
|
14
|
-
</div>
|
|
5
|
+
This guide uses simple steps. Start with the **Developer quick start**.
|
|
15
6
|
|
|
16
7
|
---
|
|
17
8
|
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
IndraQ is an internal engineering CLI that connects your team to shared infrastructure without making every developer carry organization administrator credentials.
|
|
9
|
+
# Developer quick start — Web
|
|
21
10
|
|
|
22
|
-
|
|
11
|
+
## 1. Login once
|
|
23
12
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
- `Jenkins PROD — Production`
|
|
28
|
-
- `NPM — Main Reverse Proxy`
|
|
29
|
-
- `GHCR — IndraQ`
|
|
13
|
+
```powershell
|
|
14
|
+
indraq login
|
|
15
|
+
```
|
|
30
16
|
|
|
31
|
-
|
|
17
|
+
Check your login:
|
|
32
18
|
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
A[Admin] --> S[Provider scopes]
|
|
36
|
-
S --> AWS[AWS Production]
|
|
37
|
-
S --> J[Jenkins DEV]
|
|
38
|
-
S --> N[NPM Main]
|
|
39
|
-
S --> G[GHCR]
|
|
40
|
-
AWS --> M[Scope members]
|
|
41
|
-
J --> M
|
|
42
|
-
N --> M
|
|
43
|
-
G --> M
|
|
44
|
-
M --> P[Projects]
|
|
45
|
-
P --> E[Environment: dev / staging / prod]
|
|
46
|
-
E --> D[Build & deploy]
|
|
19
|
+
```powershell
|
|
20
|
+
indraq whoami
|
|
47
21
|
```
|
|
48
22
|
|
|
49
|
-
|
|
50
|
-
> The Cloud API is built into the CLI at **https://cli.indraq.com**. Provider secrets are stored centrally and encrypted; project folders store only project references, not administrator secrets.
|
|
23
|
+
Your login stays saved. You do not need to login before every build or deploy.
|
|
51
24
|
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
## Why scopes?
|
|
25
|
+
Revoke the persistent Cloud session when you want to sign out.
|
|
55
26
|
|
|
56
|
-
|
|
27
|
+
To logout and revoke the persistent Cloud session:
|
|
57
28
|
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
| Several Jenkins servers | Unlimited named DEV/PROD Jenkins scopes |
|
|
62
|
-
| Several NPM servers | Unlimited named NPM scopes |
|
|
63
|
-
| “Which account is this?” | `scope describe` shows safe identifying metadata |
|
|
64
|
-
| Users should not see every server | Only assigned scopes are visible |
|
|
65
|
-
| Managers should not create org credentials | Only admins create scopes |
|
|
66
|
-
| Project needs a specific provider | Project/environment links override personal defaults |
|
|
67
|
-
| Existing DNS/proxy should be reused | Link existing or skip |
|
|
29
|
+
```powershell
|
|
30
|
+
indraq logout
|
|
31
|
+
```
|
|
68
32
|
|
|
69
33
|
---
|
|
70
34
|
|
|
71
|
-
##
|
|
72
|
-
|
|
73
|
-
### Provider scope
|
|
35
|
+
## 2. Open your project folder
|
|
74
36
|
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
37
|
+
```powershell
|
|
38
|
+
cd C:\Projects\my-app
|
|
39
|
+
```
|
|
78
40
|
|
|
79
|
-
|
|
41
|
+
If the project is not in IndraQ yet:
|
|
80
42
|
|
|
81
|
-
|
|
82
|
-
|
|
43
|
+
```powershell
|
|
44
|
+
indraq project create
|
|
45
|
+
```
|
|
83
46
|
|
|
84
|
-
|
|
47
|
+
Choose your project type:
|
|
85
48
|
|
|
86
|
-
|
|
49
|
+
```text
|
|
50
|
+
Frontend
|
|
51
|
+
Backend
|
|
52
|
+
Frontend + Backend
|
|
53
|
+
User Frontend + Admin Frontend + Backend
|
|
54
|
+
Mobile App
|
|
55
|
+
```
|
|
87
56
|
|
|
88
|
-
|
|
57
|
+
For web projects, choose the server/environment where the app will run.
|
|
89
58
|
|
|
90
|
-
|
|
59
|
+
Then IndraQ shows **one setup list**:
|
|
91
60
|
|
|
92
61
|
```text
|
|
93
|
-
|
|
94
|
-
├── backend → health-app-backend image / pipeline
|
|
95
|
-
├── frontend → health-app-user image / pipeline
|
|
96
|
-
└── admin → health-app-admin image / pipeline
|
|
97
|
-
```
|
|
62
|
+
What do you want to configure for this project now?
|
|
98
63
|
|
|
99
|
-
|
|
64
|
+
[x] Dockerfile(s)
|
|
65
|
+
[x] GitHub Packages
|
|
66
|
+
[x] Jenkins
|
|
67
|
+
[ ] AWS Route53
|
|
68
|
+
[ ] Nginx Proxy Manager
|
|
69
|
+
```
|
|
100
70
|
|
|
101
|
-
|
|
71
|
+
Select what you want. IndraQ only starts the items you selected.
|
|
102
72
|
|
|
103
|
-
|
|
73
|
+
It does not keep asking:
|
|
104
74
|
|
|
105
75
|
```text
|
|
106
|
-
|
|
107
|
-
├── Components: backend, user frontend, admin frontend
|
|
108
|
-
└── Deployment environments
|
|
109
|
-
├── prod-primary → Jenkins A / NPM A
|
|
110
|
-
└── prod-backup → Jenkins B / NPM B
|
|
76
|
+
Would you like to configure it now?
|
|
111
77
|
```
|
|
112
78
|
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
### Environment
|
|
79
|
+
for every item.
|
|
116
80
|
|
|
117
|
-
|
|
81
|
+
### What the setup items mean
|
|
118
82
|
|
|
119
|
-
|
|
120
|
-
|
|
83
|
+
| Option | What it does |
|
|
84
|
+
|---|---|
|
|
85
|
+
| Dockerfile(s) | Creates missing Docker files |
|
|
86
|
+
| GitHub Packages | Stores your Docker image at `ghcr.io` |
|
|
87
|
+
| Jenkins | Creates/repairs the Jenkins deploy pipeline |
|
|
88
|
+
| AWS Route53 | Creates/repairs DNS records |
|
|
89
|
+
| Nginx Proxy Manager | Creates/repairs the reverse proxy and SSL |
|
|
121
90
|
|
|
122
|
-
|
|
91
|
+
For a new Jenkins deployment, select **GitHub Packages + Jenkins** together.
|
|
123
92
|
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
| Capability | Admin | Manager | User |
|
|
127
|
-
|---|:---:|:---:|:---:|
|
|
128
|
-
| Create/delete provider scopes | ✅ | ❌ | ❌ |
|
|
129
|
-
| View assigned scopes | ✅ | ✅ | ✅ |
|
|
130
|
-
| Describe assigned scopes safely | ✅ | ✅ | ✅ |
|
|
131
|
-
| Grant `MANAGE` to a manager | ✅ | ❌ | ❌ |
|
|
132
|
-
| Add/remove normal users in managed scope | ✅ | ✅ | ❌ |
|
|
133
|
-
| Create manager/admin organization roles | ✅ | ❌ | ❌ |
|
|
134
|
-
| Change organization roles | ✅ | ❌ | ❌ |
|
|
135
|
-
| Set personal provider default | ✅ | ✅ | ✅ |
|
|
136
|
-
| Rotate own AWS access key | ✅ | ✅ | ✅ |
|
|
137
|
-
| Rotate own NPM/Jenkins password | ✅ | ✅ | ✅ |
|
|
138
|
-
| Raw provider administration | ✅ | ❌ | ❌ |
|
|
139
|
-
|
|
140
|
-
Managers can operate only inside scopes where they have `MANAGE`. A manager assigned only to `AWS — Production` cannot manage users in `AWS — Client ABC`.
|
|
141
|
-
|
|
142
|
-
```mermaid
|
|
143
|
-
flowchart TD
|
|
144
|
-
Admin -->|creates| Scope
|
|
145
|
-
Admin -->|MANAGE| Manager
|
|
146
|
-
Manager -->|USE| UserA[User]
|
|
147
|
-
Admin -->|USE| UserB[User]
|
|
148
|
-
Scope --> Manager
|
|
149
|
-
Scope --> UserA
|
|
150
|
-
Scope --> UserB
|
|
151
|
-
```
|
|
152
|
-
|
|
153
|
-
All membership changes require an audit reason and are written to the Cloud audit log.
|
|
93
|
+
Route53 and Nginx Proxy Manager run only when you select them.
|
|
154
94
|
|
|
155
95
|
---
|
|
156
96
|
|
|
157
|
-
##
|
|
97
|
+
## 3. Deploy
|
|
158
98
|
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
```bash
|
|
162
|
-
npm install -g indraq_cli
|
|
163
|
-
indraq --version
|
|
164
|
-
# or
|
|
165
|
-
indraq -V
|
|
99
|
+
```powershell
|
|
100
|
+
indraq deploy
|
|
166
101
|
```
|
|
167
102
|
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
Node.js 22+ is required.
|
|
103
|
+
For a project with more than one part, choose what you want to deploy:
|
|
171
104
|
|
|
172
|
-
|
|
105
|
+
```text
|
|
106
|
+
All components
|
|
107
|
+
Frontend
|
|
108
|
+
Backend
|
|
109
|
+
Admin frontend
|
|
110
|
+
```
|
|
173
111
|
|
|
174
|
-
|
|
112
|
+
Enter an image tag, for example:
|
|
175
113
|
|
|
176
|
-
```
|
|
177
|
-
|
|
114
|
+
```text
|
|
115
|
+
latest
|
|
178
116
|
```
|
|
179
117
|
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
Or run the individual commands manually:
|
|
118
|
+
or:
|
|
183
119
|
|
|
184
|
-
```
|
|
185
|
-
|
|
186
|
-
indraq whoami
|
|
120
|
+
```text
|
|
121
|
+
1.2.0
|
|
187
122
|
```
|
|
188
123
|
|
|
189
|
-
|
|
124
|
+
IndraQ will:
|
|
190
125
|
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
126
|
+
1. Check the project setup.
|
|
127
|
+
2. Check Dockerfiles.
|
|
128
|
+
3. Build the Docker image.
|
|
129
|
+
4. Push the image to GitHub Packages.
|
|
130
|
+
5. Start the Jenkins build.
|
|
131
|
+
6. Show the Jenkins logs in the terminal.
|
|
132
|
+
7. Wait for Jenkins to finish.
|
|
197
133
|
|
|
198
|
-
|
|
134
|
+
### If Dockerfile is missing
|
|
199
135
|
|
|
200
|
-
|
|
136
|
+
You do not need to stop and create it manually.
|
|
201
137
|
|
|
202
|
-
|
|
203
|
-
indraq scope list
|
|
204
|
-
indraq scope describe "AWS Production"
|
|
205
|
-
```
|
|
138
|
+
`indraq deploy` checks all selected components first.
|
|
206
139
|
|
|
207
|
-
|
|
140
|
+
If a Dockerfile is missing, it asks once:
|
|
208
141
|
|
|
209
142
|
```text
|
|
210
|
-
|
|
211
|
-
name Production
|
|
212
|
-
company IndraQ
|
|
213
|
-
account 123456789012
|
|
214
|
-
region ap-south-1
|
|
215
|
-
username indraq-admin
|
|
216
|
-
access use
|
|
217
|
-
default yes
|
|
218
|
-
credentials stored securely (secret hidden)
|
|
143
|
+
Generate the missing Dockerfile(s) now? Yes
|
|
219
144
|
```
|
|
220
145
|
|
|
221
|
-
|
|
146
|
+
Then deploy continues.
|
|
222
147
|
|
|
223
|
-
|
|
148
|
+
---
|
|
224
149
|
|
|
225
|
-
|
|
226
|
-
indraq user create
|
|
227
|
-
```
|
|
150
|
+
# Easy guided setup
|
|
228
151
|
|
|
229
|
-
|
|
152
|
+
If you are not sure which command to use, run:
|
|
230
153
|
|
|
231
|
-
```
|
|
232
|
-
|
|
233
|
-
[ ] AWS — Client ABC
|
|
234
|
-
[✓] Jenkins DEV — India
|
|
235
|
-
[✓] NPM — Main
|
|
236
|
-
[✓] GHCR — IndraQ
|
|
154
|
+
```powershell
|
|
155
|
+
indraq setup
|
|
237
156
|
```
|
|
238
157
|
|
|
239
|
-
|
|
158
|
+
IndraQ will guide you through:
|
|
240
159
|
|
|
241
|
-
|
|
160
|
+
1. Login.
|
|
161
|
+
2. Project create/link.
|
|
162
|
+
3. Environment selection.
|
|
163
|
+
4. One setup list.
|
|
164
|
+
5. Only the items you select.
|
|
242
165
|
|
|
243
|
-
|
|
166
|
+
Use this command for first-time setup or repair.
|
|
244
167
|
|
|
245
|
-
|
|
246
|
-
indraq project create cloud-api --kind backend --framework express --port 4010 --health /health
|
|
247
|
-
# or link this folder to an already registered project
|
|
248
|
-
indraq project link
|
|
249
|
-
```
|
|
168
|
+
---
|
|
250
169
|
|
|
251
|
-
|
|
170
|
+
# Prebuild
|
|
252
171
|
|
|
253
|
-
|
|
172
|
+
Use prebuild when you want to add or repair project services:
|
|
254
173
|
|
|
255
|
-
```
|
|
256
|
-
indraq
|
|
174
|
+
```powershell
|
|
175
|
+
indraq prebuild
|
|
257
176
|
```
|
|
258
177
|
|
|
259
|
-
|
|
178
|
+
You get one list:
|
|
260
179
|
|
|
261
|
-
|
|
180
|
+
```text
|
|
181
|
+
What should prebuild configure?
|
|
262
182
|
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
183
|
+
[ ] GitHub Packages
|
|
184
|
+
[ ] Jenkins
|
|
185
|
+
[ ] AWS Route53
|
|
186
|
+
[ ] Nginx Proxy Manager
|
|
266
187
|
```
|
|
267
188
|
|
|
268
|
-
|
|
189
|
+
Only selected items run.
|
|
269
190
|
|
|
270
|
-
|
|
271
|
-
indraq deploy
|
|
272
|
-
# choose one of the shared environments shown by the CLI
|
|
273
|
-
# or deploy directly:
|
|
274
|
-
indraq deploy --env indraq-test-airtel
|
|
275
|
-
```
|
|
191
|
+
For one environment:
|
|
276
192
|
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
```bash
|
|
280
|
-
indraq deploy --env indraq-test-airtel --select-scopes
|
|
193
|
+
```powershell
|
|
194
|
+
indraq prebuild --env production
|
|
281
195
|
```
|
|
282
196
|
|
|
283
|
-
|
|
197
|
+
For all project environments:
|
|
284
198
|
|
|
285
|
-
|
|
199
|
+
```powershell
|
|
200
|
+
indraq prebuild --all-targets
|
|
201
|
+
```
|
|
286
202
|
|
|
287
|
-
|
|
203
|
+
GitHub Packages + Jenkins only:
|
|
288
204
|
|
|
289
|
-
|
|
205
|
+
```powershell
|
|
206
|
+
indraq prebuild --required-only
|
|
207
|
+
```
|
|
290
208
|
|
|
291
|
-
|
|
209
|
+
---
|
|
292
210
|
|
|
293
|
-
|
|
294
|
-
AWS Production ★
|
|
295
|
-
AWS Development
|
|
296
|
-
AWS Client ABC
|
|
211
|
+
# Multiple servers
|
|
297
212
|
|
|
298
|
-
|
|
299
|
-
Jenkins DEV Client ABC
|
|
213
|
+
A project can run on more than one server.
|
|
300
214
|
|
|
301
|
-
|
|
302
|
-
NPM Europe
|
|
215
|
+
Choose the servers:
|
|
303
216
|
|
|
304
|
-
|
|
217
|
+
```powershell
|
|
218
|
+
indraq project environments
|
|
305
219
|
```
|
|
306
220
|
|
|
307
|
-
|
|
221
|
+
Example:
|
|
308
222
|
|
|
309
|
-
```
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
indraq scope default jenkins-dev
|
|
313
|
-
indraq scope default ghcr
|
|
223
|
+
```text
|
|
224
|
+
prod-primary
|
|
225
|
+
prod-backup
|
|
314
226
|
```
|
|
315
227
|
|
|
316
|
-
|
|
228
|
+
Deploy one server:
|
|
317
229
|
|
|
318
|
-
```
|
|
319
|
-
indraq
|
|
230
|
+
```powershell
|
|
231
|
+
indraq deploy --env prod-primary
|
|
320
232
|
```
|
|
321
233
|
|
|
322
|
-
|
|
234
|
+
Deploy all configured servers:
|
|
323
235
|
|
|
324
|
-
```
|
|
325
|
-
|
|
326
|
-
participant M as Admin / Manager
|
|
327
|
-
participant C as IndraQ Cloud
|
|
328
|
-
participant P as Provider
|
|
329
|
-
M->>C: Add user to scope + reason
|
|
330
|
-
C-->>M: Authorization check
|
|
331
|
-
M->>P: Provision native identity via scope admin credential
|
|
332
|
-
P-->>M: Native identity created
|
|
333
|
-
M->>C: Save scope membership + native mapping
|
|
334
|
-
C-->>M: Audited success
|
|
236
|
+
```powershell
|
|
237
|
+
indraq deploy --all
|
|
335
238
|
```
|
|
336
239
|
|
|
337
|
-
|
|
240
|
+
IndraQ builds the image once and sends the **same exact image** to every selected Jenkins server.
|
|
338
241
|
|
|
339
|
-
|
|
340
|
-
indraq scope remove-user
|
|
341
|
-
```
|
|
242
|
+
---
|
|
342
243
|
|
|
343
|
-
|
|
244
|
+
# Jenkins build reliability
|
|
344
245
|
|
|
345
|
-
|
|
246
|
+
IndraQ v2.5.0 is safer when Jenkins or the reverse proxy is slow.
|
|
346
247
|
|
|
347
|
-
|
|
348
|
-
indraq scope audit
|
|
349
|
-
```
|
|
248
|
+
If Jenkins accepts the deploy request but the CLI temporarily gets a timeout or 502, IndraQ does **not** automatically send the same deploy again.
|
|
350
249
|
|
|
351
|
-
|
|
250
|
+
It tries to find the Jenkins build that was already started and continues following that build.
|
|
352
251
|
|
|
353
|
-
|
|
252
|
+
If IndraQ cannot safely find the build, it tells you to check Jenkins before retrying. This avoids duplicate deployments.
|
|
354
253
|
|
|
355
|
-
|
|
254
|
+
---
|
|
356
255
|
|
|
357
|
-
|
|
256
|
+
# GitHub Packages
|
|
358
257
|
|
|
359
|
-
|
|
258
|
+
The CLI now shows the name:
|
|
360
259
|
|
|
361
|
-
```
|
|
362
|
-
|
|
363
|
-
indraq scope rotate-key
|
|
260
|
+
```text
|
|
261
|
+
GitHub Packages
|
|
364
262
|
```
|
|
365
263
|
|
|
366
|
-
|
|
264
|
+
Internally the Docker registry is still:
|
|
367
265
|
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
```bash
|
|
371
|
-
indraq scope rotate-password
|
|
266
|
+
```text
|
|
267
|
+
ghcr.io
|
|
372
268
|
```
|
|
373
269
|
|
|
374
|
-
|
|
270
|
+
Developers do not need to remember the name `GHCR`.
|
|
375
271
|
|
|
376
272
|
---
|
|
377
273
|
|
|
378
|
-
|
|
274
|
+
# Web environment IPs
|
|
379
275
|
|
|
380
|
-
|
|
276
|
+
Admins create web environments with two IPs:
|
|
381
277
|
|
|
382
|
-
```
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
P --> R[prod]
|
|
386
|
-
D --> JD[Jenkins DEV India]
|
|
387
|
-
D --> GD[GHCR IndraQ]
|
|
388
|
-
D --> AD[AWS Development]
|
|
389
|
-
R --> JP[Jenkins PROD]
|
|
390
|
-
R --> GP[GHCR IndraQ]
|
|
391
|
-
R --> AP[AWS Production]
|
|
392
|
-
R --> NP[NPM Production]
|
|
393
|
-
```
|
|
394
|
-
|
|
395
|
-
Use:
|
|
396
|
-
|
|
397
|
-
```bash
|
|
398
|
-
indraq project scopes --env indraq-test-airtel
|
|
399
|
-
indraq project scopes --env prod
|
|
278
|
+
```text
|
|
279
|
+
External/Public IPv4
|
|
280
|
+
Internal/Private IPv4
|
|
400
281
|
```
|
|
401
282
|
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
### Configure where a project may deploy
|
|
283
|
+
They are used like this:
|
|
405
284
|
|
|
406
|
-
```
|
|
407
|
-
|
|
285
|
+
```text
|
|
286
|
+
AWS Route53 -> External/Public IPv4
|
|
287
|
+
Nginx Proxy Manager -> Internal/Private IPv4
|
|
408
288
|
```
|
|
409
289
|
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
Each environment keeps its own provider-scope links, so `prod-primary` may use Jenkins/NPM instance A while `prod-backup` uses Jenkins/NPM instance B. The logical component pipeline/image name remains the same across those servers.
|
|
290
|
+
Developers normally only select the environment name.
|
|
413
291
|
|
|
414
292
|
---
|
|
415
293
|
|
|
416
|
-
|
|
294
|
+
# Audit reasons
|
|
417
295
|
|
|
296
|
+
Normal creation/setup should stay quick.
|
|
418
297
|
|
|
419
|
-
|
|
298
|
+
IndraQ does **not** ask for an audit reason when creating or setting up new items such as:
|
|
420
299
|
|
|
421
|
-
|
|
300
|
+
- project creation
|
|
301
|
+
- environment creation
|
|
302
|
+
- provider scope creation
|
|
303
|
+
- mobile environment creation
|
|
304
|
+
- automatic setup/prebuild links
|
|
422
305
|
|
|
423
|
-
|
|
424
|
-
- **Internal/Private IPv4** — used by Nginx Proxy Manager as the upstream server address.
|
|
306
|
+
IndraQ writes a safe automatic reason for those actions.
|
|
425
307
|
|
|
426
|
-
|
|
308
|
+
IndraQ asks for a reason when you change or delete existing data, for example:
|
|
427
309
|
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
310
|
+
- update/delete an environment
|
|
311
|
+
- update/delete a user
|
|
312
|
+
- rename/delete a project
|
|
313
|
+
- archive/restore a project
|
|
314
|
+
- remove access
|
|
315
|
+
- rotate credentials
|
|
433
316
|
|
|
434
|
-
|
|
317
|
+
---
|
|
435
318
|
|
|
436
|
-
|
|
319
|
+
# Mobile quick start
|
|
437
320
|
|
|
438
|
-
|
|
321
|
+
IndraQ supports:
|
|
439
322
|
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
# choose backend / user frontend / admin frontend / all components
|
|
443
|
-
# choose prod-primary / prod-backup / ALL configured environments
|
|
323
|
+
- Expo
|
|
324
|
+
- React Native CLI
|
|
444
325
|
|
|
445
|
-
|
|
446
|
-
|
|
326
|
+
Create a new mobile project:
|
|
327
|
+
|
|
328
|
+
```powershell
|
|
329
|
+
indraq init
|
|
447
330
|
```
|
|
448
331
|
|
|
449
|
-
|
|
332
|
+
Choose:
|
|
450
333
|
|
|
451
334
|
```text
|
|
452
|
-
|
|
453
|
-
↓
|
|
454
|
-
build once
|
|
455
|
-
↓
|
|
456
|
-
GHCR tag + sha256 digest
|
|
457
|
-
├── Jenkins / prod-primary
|
|
458
|
-
└── Jenkins / prod-backup
|
|
335
|
+
Mobile App
|
|
459
336
|
```
|
|
460
337
|
|
|
461
|
-
|
|
338
|
+
Then choose:
|
|
462
339
|
|
|
463
|
-
```
|
|
464
|
-
|
|
340
|
+
```text
|
|
341
|
+
Expo
|
|
465
342
|
```
|
|
466
343
|
|
|
467
|
-
|
|
344
|
+
or:
|
|
468
345
|
|
|
469
|
-
```
|
|
470
|
-
|
|
471
|
-
Start[indraq prebuild --env dev] --> G{GHCR scope?}
|
|
472
|
-
G -->|No| Stop1[Stop: required]
|
|
473
|
-
G -->|Yes| J{Jenkins scope?}
|
|
474
|
-
J -->|No| Stop2[Stop: required]
|
|
475
|
-
J -->|Yes| Job[Reconcile Jenkins deployment]
|
|
476
|
-
Job --> DNS{Route53?}
|
|
477
|
-
DNS -->|Skip| NPM
|
|
478
|
-
DNS -->|Create| DNSC[Create / reconcile]
|
|
479
|
-
DNS -->|Link existing| DNSL[Link without modifying]
|
|
480
|
-
DNSC --> NPM{NPM?}
|
|
481
|
-
DNSL --> NPM
|
|
482
|
-
NPM -->|Skip| Ready[Ready]
|
|
483
|
-
NPM -->|Create| NPC[Create / reconcile proxy]
|
|
484
|
-
NPM -->|Link existing| NPL[Link existing proxy]
|
|
485
|
-
NPC --> Ready
|
|
486
|
-
NPL --> Ready
|
|
346
|
+
```text
|
|
347
|
+
React Native CLI
|
|
487
348
|
```
|
|
488
349
|
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
- GHCR image association
|
|
492
|
-
- Jenkins deployment/pipeline association
|
|
350
|
+
For an existing mobile project:
|
|
493
351
|
|
|
494
|
-
|
|
352
|
+
```powershell
|
|
353
|
+
indraq project create
|
|
354
|
+
```
|
|
495
355
|
|
|
496
|
-
|
|
497
|
-
- **Create / reconcile** — create or repair a managed Route53 record.
|
|
498
|
-
- **Link existing** — select an existing record and record the association without modifying it.
|
|
356
|
+
and select **Mobile App**.
|
|
499
357
|
|
|
500
|
-
|
|
358
|
+
---
|
|
501
359
|
|
|
502
|
-
|
|
503
|
-
- **Create / reconcile** — create or repair an NPM proxy host.
|
|
504
|
-
- **Link existing** — select an existing proxy and associate it without modifying it.
|
|
360
|
+
# Mobile prebuild
|
|
505
361
|
|
|
506
|
-
|
|
362
|
+
Inside the mobile project:
|
|
507
363
|
|
|
508
|
-
|
|
364
|
+
```powershell
|
|
365
|
+
indraq prebuild
|
|
366
|
+
```
|
|
509
367
|
|
|
510
|
-
|
|
368
|
+
or:
|
|
511
369
|
|
|
512
|
-
```
|
|
513
|
-
indraq
|
|
514
|
-
indraq deploy --env staging
|
|
515
|
-
indraq deploy --env prod
|
|
370
|
+
```powershell
|
|
371
|
+
indraq mobile prebuild
|
|
516
372
|
```
|
|
517
373
|
|
|
518
|
-
|
|
374
|
+
Mobile prebuild configures only:
|
|
519
375
|
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
└── dev
|
|
523
|
-
├── Jenkins scope + job
|
|
524
|
-
├── GHCR scope + image
|
|
525
|
-
├── optional AWS/DNS resource
|
|
526
|
-
└── optional NPM proxy resource
|
|
527
|
-
```
|
|
376
|
+
- Jenkins
|
|
377
|
+
- IndraQ OTA
|
|
528
378
|
|
|
529
|
-
It does not
|
|
379
|
+
It does not configure:
|
|
530
380
|
|
|
531
|
-
|
|
381
|
+
- Docker
|
|
382
|
+
- GitHub Packages
|
|
383
|
+
- AWS
|
|
384
|
+
- Route53
|
|
385
|
+
- Nginx Proxy Manager
|
|
532
386
|
|
|
533
387
|
---
|
|
534
388
|
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
IndraQ requires the Jenkins **Role Strategy** authorization strategy for managed access.
|
|
389
|
+
# Mobile builds
|
|
538
390
|
|
|
539
|
-
|
|
391
|
+
Development:
|
|
540
392
|
|
|
541
|
-
|
|
393
|
+
```powershell
|
|
394
|
+
indraq build mobile:dev
|
|
395
|
+
```
|
|
542
396
|
|
|
543
|
-
|
|
544
|
-
Role: indraq-<user>-<scope>
|
|
545
|
-
Pattern: ^(?:accounting-service|accounting-worker)$
|
|
397
|
+
Staging:
|
|
546
398
|
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
Job/Read ✓
|
|
550
|
-
Job/Build ✓
|
|
551
|
-
Job/Cancel ✓
|
|
552
|
-
Job/Workspace ✓
|
|
553
|
-
Job/Configure ✗
|
|
554
|
-
Overall/Admin ✗
|
|
399
|
+
```powershell
|
|
400
|
+
indraq build mobile:staging
|
|
555
401
|
```
|
|
556
402
|
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
R --> B[accounting-worker]
|
|
562
|
-
R -. no access .-> C[unrelated-production-job]
|
|
403
|
+
Production:
|
|
404
|
+
|
|
405
|
+
```powershell
|
|
406
|
+
indraq build mobile:prod
|
|
563
407
|
```
|
|
564
408
|
|
|
565
|
-
|
|
409
|
+
A successful native Jenkins build saves the app's native fingerprint in IndraQ Cloud. OTA is allowed only when the current app is compatible with that native build.
|
|
566
410
|
|
|
567
411
|
---
|
|
568
412
|
|
|
569
|
-
|
|
413
|
+
# OTA updates
|
|
414
|
+
|
|
415
|
+
OTA sends JavaScript and asset changes without publishing a new store build when native code did not change.
|
|
570
416
|
|
|
571
|
-
|
|
417
|
+
Backend:
|
|
572
418
|
|
|
573
419
|
```text
|
|
574
|
-
|
|
575
|
-
→ selected AWS identities
|
|
576
|
-
→ selected NPM identities
|
|
577
|
-
→ selected Jenkins identities
|
|
578
|
-
→ scope memberships
|
|
420
|
+
https://cli.indraq.com
|
|
579
421
|
```
|
|
580
422
|
|
|
581
|
-
|
|
423
|
+
OTA files are stored in MinIO.
|
|
582
424
|
|
|
583
|
-
|
|
425
|
+
## Send a test update
|
|
584
426
|
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
```bash
|
|
588
|
-
indraq user update rajvir --role manager
|
|
589
|
-
indraq user update rajvir --role user
|
|
427
|
+
```powershell
|
|
428
|
+
indraq mobile send update --app "My App" --env production
|
|
590
429
|
```
|
|
591
430
|
|
|
592
|
-
|
|
431
|
+
You can target:
|
|
593
432
|
|
|
594
|
-
|
|
433
|
+
- installation ID
|
|
434
|
+
- user ID
|
|
435
|
+
- username
|
|
436
|
+
- email
|
|
437
|
+
- phone
|
|
438
|
+
- percentage of users
|
|
439
|
+
- everyone
|
|
595
440
|
|
|
596
|
-
|
|
597
|
-
indraq user delete rajvir
|
|
598
|
-
```
|
|
441
|
+
The app checks for an OTA update when the app starts. If an update is found, it downloads it and reloads before the user starts normal work.
|
|
599
442
|
|
|
600
|
-
|
|
443
|
+
## Release the same tested update to everyone
|
|
601
444
|
|
|
602
|
-
|
|
445
|
+
```powershell
|
|
446
|
+
indraq mobile release update --app "My App"
|
|
447
|
+
```
|
|
603
448
|
|
|
604
|
-
|
|
449
|
+
IndraQ does not rebuild the bundle. It releases the same bundle you already tested.
|
|
605
450
|
|
|
606
|
-
|
|
451
|
+
## Metrics
|
|
607
452
|
|
|
608
|
-
|
|
453
|
+
```powershell
|
|
454
|
+
indraq mobile metrics --app "My App"
|
|
455
|
+
```
|
|
609
456
|
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
indraq
|
|
614
|
-
indraq help users
|
|
615
|
-
indraq help environment
|
|
616
|
-
indraq help deploy
|
|
617
|
-
indraq help configure
|
|
618
|
-
indraq help aws
|
|
457
|
+
## Pause an update
|
|
458
|
+
|
|
459
|
+
```powershell
|
|
460
|
+
indraq mobile pause --app "My App"
|
|
619
461
|
```
|
|
620
462
|
|
|
463
|
+
## Roll back
|
|
621
464
|
|
|
622
|
-
|
|
465
|
+
```powershell
|
|
466
|
+
indraq mobile rollback --app "My App"
|
|
467
|
+
```
|
|
623
468
|
|
|
624
|
-
|
|
625
|
-
|---|---|
|
|
626
|
-
| `indraq login` | Sign in |
|
|
627
|
-
| `indraq logout` | Revoke the persistent Cloud session and remove local session credentials |
|
|
628
|
-
| `indraq whoami` | Show current identity |
|
|
629
|
-
| `indraq doctor` | Diagnose Node/Java/Git/tar/PATH |
|
|
630
|
-
| `indraq logs` | Audit/log access where permitted |
|
|
469
|
+
---
|
|
631
470
|
|
|
632
|
-
|
|
471
|
+
# Admin commands
|
|
633
472
|
|
|
634
|
-
|
|
635
|
-
|---|---|
|
|
636
|
-
| `indraq scope list` | List assigned scopes |
|
|
637
|
-
| `indraq scope describe [nameOrId]` | Safe scope identity/details |
|
|
638
|
-
| `indraq scope create [provider]` | Admin creates organization scope |
|
|
639
|
-
| `indraq scope delete [nameOrId]` | Admin deletes unused scope |
|
|
640
|
-
| `indraq scope members` | List members of manageable scope |
|
|
641
|
-
| `indraq scope add-user` | Add/provision user |
|
|
642
|
-
| `indraq scope remove-user` | Remove/deprovision user |
|
|
643
|
-
| `indraq scope default [provider]` | Personal provider default |
|
|
644
|
-
| `indraq scope audit` | Scope audit trail |
|
|
645
|
-
| `indraq scope credentials` | Own AWS credential |
|
|
646
|
-
| `indraq scope rotate-key` | Rotate own AWS access key |
|
|
647
|
-
| `indraq scope rotate-password` | Rotate own NPM/Jenkins password |
|
|
648
|
-
|
|
649
|
-
### Users
|
|
650
|
-
|
|
651
|
-
| Command | Use |
|
|
652
|
-
|---|---|
|
|
653
|
-
| `indraq user list` | List organization users |
|
|
654
|
-
| `indraq user scopes [email]` | Show your own or a manageable user's assigned scopes |
|
|
655
|
-
| `indraq user create [username]` | Create user + select scopes |
|
|
656
|
-
| `indraq user update [username]` | Password/role operations |
|
|
657
|
-
| `indraq user delete [username]` | Hard delete after scope cleanup |
|
|
658
|
-
| `indraq password reset` | Self-service Cloud password reset |
|
|
473
|
+
Developers normally do not need this section.
|
|
659
474
|
|
|
660
|
-
|
|
475
|
+
## Web environments
|
|
661
476
|
|
|
662
|
-
|
|
663
|
-
|---|---|
|
|
664
|
-
| `indraq init [directory]` | Initialize/link project |
|
|
665
|
-
| `indraq project create [name]` | Register existing project |
|
|
666
|
-
| `indraq project list` | List accessible projects |
|
|
667
|
-
| `indraq project link` | Link current folder |
|
|
668
|
-
| `indraq project status` | Show project resources |
|
|
669
|
-
| `indraq project environments` | Choose one or multiple allowed deployment environments/servers |
|
|
670
|
-
| `indraq project scopes --env <env>` | Select project provider scopes |
|
|
671
|
-
| `indraq project add user` | Add project member + synchronize access |
|
|
672
|
-
| `indraq project delete user` | Remove project member |
|
|
673
|
-
| `indraq project rename [name]` | Rename the current project |
|
|
674
|
-
| `indraq project archive` | Archive the current project and block normal deployment access |
|
|
675
|
-
| `indraq project restore` | Restore an archived project |
|
|
676
|
-
| `indraq project delete` | Permanently delete current project metadata |
|
|
677
|
-
| `indraq access add user` | Add selected resource grants |
|
|
678
|
-
| `indraq access delete user` | Remove selected resource grants |
|
|
679
|
-
|
|
680
|
-
### Deploy and Jenkins
|
|
681
|
-
|
|
682
|
-
| Command | Use |
|
|
683
|
-
|---|---|
|
|
684
|
-
| `indraq prebuild --env <env>` | Reconcile infrastructure for one environment |
|
|
685
|
-
| `indraq prebuild --all-targets --required-only` | Reconcile required GHCR/Jenkins pipelines on every configured target |
|
|
686
|
-
| `indraq deploy` | Choose component(s) and one/all configured project environments |
|
|
687
|
-
| `indraq deploy --env <env>` | Deploy one configured project environment using its saved scope bindings |
|
|
688
|
-
| `indraq deploy --all` | Build once per component and deploy the same immutable digest to every configured environment |
|
|
689
|
-
| `indraq deploy:dev` | Convenience alias if `dev`/`development` exists; otherwise opens the environment picker |
|
|
690
|
-
| `indraq deploy:prod` | Convenience alias if `prod`/`production` exists; otherwise opens the environment picker |
|
|
691
|
-
| `indraq deploy --env <env> --select-scopes` | Explicitly review/change project scope bindings before deploy |
|
|
692
|
-
| `indraq jenkins pipelines --stage dev` | List visible pipelines |
|
|
693
|
-
| `indraq jenkins build [job] --stage dev` | Select a visible pipeline, discover its Jenkins parameters, prompt for required inputs, and trigger it |
|
|
694
|
-
| `indraq jenkins run [job] --stage dev` | Compatibility alias for `jenkins build` |
|
|
477
|
+
Create:
|
|
695
478
|
|
|
696
|
-
|
|
479
|
+
```powershell
|
|
480
|
+
indraq environment create
|
|
481
|
+
```
|
|
697
482
|
|
|
698
|
-
|
|
483
|
+
List:
|
|
699
484
|
|
|
485
|
+
```powershell
|
|
486
|
+
indraq environment list
|
|
487
|
+
```
|
|
700
488
|
|
|
701
|
-
|
|
489
|
+
Update:
|
|
702
490
|
|
|
703
|
-
|
|
491
|
+
```powershell
|
|
492
|
+
indraq environment update <name>
|
|
493
|
+
```
|
|
704
494
|
|
|
705
|
-
|
|
495
|
+
Delete:
|
|
706
496
|
|
|
707
|
-
```
|
|
708
|
-
indraq
|
|
709
|
-
indraq iam user:create alice
|
|
710
|
-
indraq dns zones
|
|
711
|
-
indraq dns records
|
|
712
|
-
indraq healthcheck list
|
|
713
|
-
indraq npm-user create
|
|
714
|
-
indraq proxy create api.example.com
|
|
497
|
+
```powershell
|
|
498
|
+
indraq environment delete <name>
|
|
715
499
|
```
|
|
716
500
|
|
|
717
|
-
|
|
501
|
+
## Mobile environments
|
|
718
502
|
|
|
503
|
+
Create:
|
|
719
504
|
|
|
720
|
-
|
|
505
|
+
```powershell
|
|
506
|
+
indraq mobile environment create
|
|
507
|
+
```
|
|
721
508
|
|
|
722
|
-
|
|
509
|
+
List:
|
|
723
510
|
|
|
724
|
-
```
|
|
511
|
+
```powershell
|
|
725
512
|
indraq mobile environment list
|
|
726
|
-
indraq mobile environment create # ADMIN
|
|
727
|
-
indraq prebuild --env production
|
|
728
|
-
indraq build mobile:prod
|
|
729
513
|
```
|
|
730
514
|
|
|
731
|
-
|
|
515
|
+
## Provider connections
|
|
732
516
|
|
|
733
|
-
|
|
517
|
+
Create a provider connection:
|
|
734
518
|
|
|
735
|
-
```
|
|
736
|
-
indraq
|
|
737
|
-
indraq mobile "My App" release update
|
|
738
|
-
indraq mobile "My App" pause
|
|
739
|
-
indraq mobile "My App" rollback
|
|
740
|
-
indraq mobile "My App" metrics
|
|
519
|
+
```powershell
|
|
520
|
+
indraq scope create
|
|
741
521
|
```
|
|
742
522
|
|
|
743
|
-
|
|
523
|
+
Provider names shown in the CLI:
|
|
744
524
|
|
|
745
|
-
|
|
525
|
+
```text
|
|
526
|
+
AWS
|
|
527
|
+
Nginx Proxy Manager
|
|
528
|
+
Jenkins Development
|
|
529
|
+
Jenkins Production
|
|
530
|
+
GitHub Packages
|
|
531
|
+
```
|
|
746
532
|
|
|
747
|
-
|
|
533
|
+
List them:
|
|
748
534
|
|
|
749
|
-
|
|
535
|
+
```powershell
|
|
536
|
+
indraq scope list
|
|
537
|
+
```
|
|
750
538
|
|
|
751
|
-
|
|
539
|
+
## Users
|
|
752
540
|
|
|
753
|
-
|
|
541
|
+
Create a user:
|
|
754
542
|
|
|
755
|
-
|
|
543
|
+
```powershell
|
|
544
|
+
indraq user create
|
|
545
|
+
```
|
|
756
546
|
|
|
757
|
-
|
|
547
|
+
List users:
|
|
758
548
|
|
|
759
|
-
```
|
|
760
|
-
indraq
|
|
761
|
-
indraq scope create jenkins-dev
|
|
762
|
-
indraq scope create npm
|
|
763
|
-
indraq scope describe
|
|
764
|
-
indraq scope add-user
|
|
549
|
+
```powershell
|
|
550
|
+
indraq user list
|
|
765
551
|
```
|
|
766
552
|
|
|
767
|
-
|
|
553
|
+
When IndraQ creates a Nginx Proxy Manager user, it now tests that user's email/password login before reporting success.
|
|
768
554
|
|
|
769
|
-
|
|
770
|
-
indraq scope add-user
|
|
771
|
-
```
|
|
555
|
+
---
|
|
772
556
|
|
|
773
|
-
|
|
557
|
+
# Common commands
|
|
774
558
|
|
|
775
|
-
|
|
559
|
+
| Task | Command |
|
|
560
|
+
|---|---|
|
|
561
|
+
| Login | `indraq login` |
|
|
562
|
+
| Check login | `indraq whoami` |
|
|
563
|
+
| Guided setup | `indraq setup` |
|
|
564
|
+
| Create project | `indraq project create` |
|
|
565
|
+
| Project status | `indraq project status` |
|
|
566
|
+
| Choose project servers | `indraq project environments` |
|
|
567
|
+
| Configure project services | `indraq prebuild` |
|
|
568
|
+
| Deploy web app | `indraq deploy` |
|
|
569
|
+
| Create Dockerfile | `indraq dockerfile create` |
|
|
570
|
+
| List environments | `indraq environment list` |
|
|
571
|
+
| List provider connections | `indraq scope list` |
|
|
572
|
+
| Create user | `indraq user create` |
|
|
573
|
+
| Run Jenkins pipeline | `indraq jenkins run` |
|
|
574
|
+
| Mobile prebuild | `indraq mobile prebuild` |
|
|
575
|
+
| Mobile production build | `indraq build mobile:prod` |
|
|
576
|
+
| Send OTA | `indraq mobile send update --app "My App"` |
|
|
577
|
+
| OTA metrics | `indraq mobile metrics --app "My App"` |
|
|
578
|
+
| Main help | `indraq --help` |
|
|
579
|
+
| Topic help | `indraq help project` |
|
|
776
580
|
|
|
777
|
-
|
|
778
|
-
indraq scope list
|
|
779
|
-
indraq scope describe "AWS Client ABC"
|
|
780
|
-
indraq project scopes --env indraq-test-airtel
|
|
781
|
-
indraq prebuild --env dev
|
|
782
|
-
indraq deploy:dev
|
|
783
|
-
```
|
|
581
|
+
---
|
|
784
582
|
|
|
785
|
-
|
|
583
|
+
# Troubleshooting
|
|
786
584
|
|
|
787
|
-
|
|
788
|
-
indraq prebuild --env dev
|
|
789
|
-
```
|
|
585
|
+
## Dockerfile is missing
|
|
790
586
|
|
|
791
|
-
|
|
587
|
+
Run:
|
|
792
588
|
|
|
793
|
-
|
|
589
|
+
```powershell
|
|
590
|
+
indraq deploy
|
|
591
|
+
```
|
|
794
592
|
|
|
795
|
-
|
|
593
|
+
and choose **Yes** when IndraQ offers to create the missing Dockerfile(s).
|
|
796
594
|
|
|
797
|
-
|
|
798
|
-
> Scope descriptions are intentionally safe, but provider scope administration is privileged. Do not paste secrets, generated access keys, API tokens or temporary passwords into tickets or chat.
|
|
595
|
+
Or run:
|
|
799
596
|
|
|
800
|
-
|
|
597
|
+
```powershell
|
|
598
|
+
indraq dockerfile create
|
|
599
|
+
```
|
|
801
600
|
|
|
802
|
-
|
|
803
|
-
- Only admins create organization credentials/scopes.
|
|
804
|
-
- Managers can manage only normal users inside scopes where they hold MANAGE.
|
|
805
|
-
- Users rotate only their own provider identities.
|
|
806
|
-
- Every sensitive resolve/membership operation is audited.
|
|
807
|
-
- Cloud deletion happens after external provider cleanup.
|
|
808
|
-
- Jenkins project access uses least-privilege Item Roles.
|
|
809
|
-
- Project definitions/infrastructure survive user deletion.
|
|
601
|
+
## Jenkins looks stuck
|
|
810
602
|
|
|
811
|
-
|
|
603
|
+
Do not immediately run deploy again.
|
|
812
604
|
|
|
813
|
-
|
|
605
|
+
IndraQ v2.5.0 tries to reconnect to the same Jenkins build.
|
|
814
606
|
|
|
815
|
-
|
|
607
|
+
If IndraQ says the result is uncertain, open Jenkins and check whether the build started before retrying.
|
|
816
608
|
|
|
817
|
-
|
|
609
|
+
## Nginx Proxy Manager gives 401 for a user
|
|
818
610
|
|
|
819
|
-
|
|
611
|
+
New users created with v2.5.0 are tested during creation.
|
|
820
612
|
|
|
821
|
-
|
|
613
|
+
For an old user, rotate/recreate the NPM user credential. IndraQ uses the user's **email address** as the NPM login identity.
|
|
822
614
|
|
|
823
|
-
|
|
615
|
+
## Need Route53 or NPM after project creation
|
|
824
616
|
|
|
825
|
-
|
|
617
|
+
Run:
|
|
826
618
|
|
|
827
|
-
```
|
|
828
|
-
indraq
|
|
619
|
+
```powershell
|
|
620
|
+
indraq prebuild
|
|
829
621
|
```
|
|
830
622
|
|
|
831
|
-
|
|
623
|
+
Select only the missing item.
|
|
832
624
|
|
|
833
|
-
|
|
625
|
+
## Need a full setup/repair
|
|
834
626
|
|
|
835
|
-
|
|
836
|
-
|
|
627
|
+
Run:
|
|
628
|
+
|
|
629
|
+
```powershell
|
|
630
|
+
indraq setup
|
|
837
631
|
```
|
|
838
632
|
|
|
839
|
-
|
|
633
|
+
---
|
|
840
634
|
|
|
841
|
-
|
|
635
|
+
# Cloud API development
|
|
842
636
|
|
|
843
|
-
|
|
637
|
+
The Cloud API has its own npm dependencies.
|
|
638
|
+
|
|
639
|
+
From the repository root:
|
|
844
640
|
|
|
845
|
-
|
|
641
|
+
```powershell
|
|
642
|
+
cd cloud-api
|
|
643
|
+
npm install
|
|
644
|
+
npm run build
|
|
645
|
+
npm run dev
|
|
646
|
+
```
|
|
846
647
|
|
|
847
|
-
|
|
648
|
+
Running `npm install` in the root folder does not install `cloud-api` dependencies.
|
|
649
|
+
|
|
650
|
+
Cloud API environment settings are in:
|
|
848
651
|
|
|
849
652
|
```text
|
|
850
|
-
cloud-api
|
|
851
|
-
...
|
|
852
|
-
cloud-api/sql/009_scope_user_secrets_and_project_lifecycle.sql
|
|
853
|
-
cloud-api/sql/010_persistent_auth_sessions.sql
|
|
854
|
-
cloud-api/sql/011_environment_internal_ipv4.sql
|
|
653
|
+
cloud-api/.env.example
|
|
855
654
|
```
|
|
856
655
|
|
|
857
|
-
Migration `010` provides persistent CLI sessions. Migration `011` separates external/public environment IPv4 (Route53) from internal/private IPv4 (NPM).
|
|
858
|
-
|
|
859
656
|
---
|
|
860
657
|
|
|
861
|
-
|
|
658
|
+
# Before publishing the CLI
|
|
862
659
|
|
|
863
|
-
|
|
660
|
+
From the repository root:
|
|
661
|
+
|
|
662
|
+
```powershell
|
|
864
663
|
npm install
|
|
865
664
|
npm run build
|
|
866
665
|
npm test
|
|
867
|
-
npm
|
|
666
|
+
npm publish --dry-run
|
|
868
667
|
```
|
|
869
668
|
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
```bash
|
|
873
|
-
npm --prefix cloud-api install
|
|
874
|
-
npm --prefix cloud-api run build
|
|
669
|
+
Then:
|
|
875
670
|
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
# npm --prefix cloud-api run dev
|
|
671
|
+
```powershell
|
|
672
|
+
npm publish
|
|
879
673
|
```
|
|
880
674
|
|
|
881
675
|
---
|
|
882
676
|
|
|
883
|
-
|
|
884
|
-
|
|
677
|
+
**IndraQ Innovations — IndraQ CLI v2.6.0**
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
---
|
|
681
|
+
|
|
682
|
+
# What is new in v2.6.0
|
|
683
|
+
|
|
684
|
+
## Backend + Mobile App
|
|
685
|
+
|
|
686
|
+
Choose **Backend + Mobile App** under `indraq init` or `indraq project create`.
|
|
687
|
+
The backend lives in `backend/` and uses normal Docker, GitHub Packages, Jenkins,
|
|
688
|
+
Route53, and NPM provisioning. The mobile app lives in `mobile/` and uses
|
|
689
|
+
Jenkins native builds and IndraQ OTA. `indraq setup` configures both once.
|
|
690
|
+
|
|
691
|
+
## Project deletion cleanup
|
|
692
|
+
|
|
693
|
+
`indraq project delete` lists the actual resources linked to the project and
|
|
694
|
+
asks which to delete: Route53 A records, GitHub Packages container packages,
|
|
695
|
+
project-specific Jenkins jobs, and NPM proxy hosts. **Everything starts as KEEP.**
|
|
696
|
+
Shared resources and the shared mobile Jenkins pipeline are protected.
|
|
697
|
+
An external resource marked as linked requires extra approval to delete.
|
|
698
|
+
If any chosen provider deletion fails, the Cloud project stays available for retry.
|
|
699
|
+
Deleting GitHub Packages removes all tags and versions of the selected package.
|
|
700
|
+
AWS health checks, NPM certificates, running containers, and local source files
|
|
701
|
+
are not automatically deleted. `--yes` does not select any resources automatically.
|
|
885
702
|
|
|
886
|
-
|
|
703
|
+
## Windows OTA signing fix
|
|
887
704
|
|
|
888
|
-
|
|
889
|
-
|
|
705
|
+
`expo-updates codesigning:generate` now uses a Windows-safe argument-preserving
|
|
706
|
+
`npx` launcher. Temporary private key material is cleaned up after errors too.
|