Skip to content

Commit 0bab819

Browse files
chore: new release with minimal changes
1 parent 59240d1 commit 0bab819

File tree

4 files changed

+39
-11
lines changed

4 files changed

+39
-11
lines changed

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -90,21 +90,26 @@ Run the proxy as a Windows Service for background persistence.
9090
# Install service (Admin required)
9191
cloudsqlctl service install --instance "my-project:region:instance" --port 5432
9292
93+
# Configure startup type (Automatic, Manual, Disabled, Delayed)
94+
cloudsqlctl service startup Automatic
95+
9396
# Start service
9497
cloudsqlctl service start
9598
96-
# 2. Select your database instance
97-
cloudsqlctl select
99+
# Check status
100+
cloudsqlctl service status
101+
```
102+
103+
### Interactive Authentication
98104

99-
# Or list and connect directly
100-
cloudsqlctl list
101-
cloudsqlctl connect project:region:instance
105+
Manage Service Account keys interactively:
102106

103-
# 3. Start the proxy (if using select)
104-
cloudsqlctl start
107+
```powershell
108+
# List installed keys
109+
cloudsqlctl auth list-keys
105110
106-
# 4. Check status
107-
cloudsqlctl status
111+
# Interactively select a key to use
112+
cloudsqlctl auth select-key
108113
```
109114

110115
## Configuration

docs/Configuration.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ cloudsqlctl auth login
3434
3535
# Set up Application Default Credentials (ADC) - Required for the proxy
3636
cloudsqlctl auth adc
37+
38+
# Manage Service Account keys
39+
cloudsqlctl auth list-keys
40+
cloudsqlctl auth select-key
3741
```
3842

3943
### 2. Select an Instance
@@ -70,7 +74,10 @@ For production or long-running background tasks, you can install the proxy as a
7074

7175
```powershell
7276
# Install the service
73-
cloudsqlctl service install
77+
cloudsqlctl service install --instance "project:region:instance"
78+
79+
# Configure startup type (Automatic, Manual, Disabled, Delayed)
80+
cloudsqlctl service startup Automatic
7481
7582
# Start the service
7683
cloudsqlctl service start

docs/Home.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
- **Authentication Management**: Built-in `auth` command for gcloud login, ADC setup, and Service Account management.
99
- **Automated Installation**: Downloads and verifies the official Cloud SQL Proxy binary.
1010
- **Instance Management**: Lists and selects Cloud SQL instances using your active `gcloud` configuration.
11-
- **Process Management**: Starts, stops, and restarts the proxy as a background process or Windows Service.
11+
- **Process Management**: Starts, stops, and restarts the proxy as a background process or Windows Service (with configurable startup types).
1212
- **Structured Logging**: JSON logging with automatic masking of sensitive tokens.
1313
- **Diagnostics**: Built-in `doctor` command to check environment health (gcloud, ADC, network, service).
1414
- **Self-Update**: Easily update the proxy binary to the latest version.

docs/Troubleshooting.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,22 @@ Or manually: `gcloud auth application-default login`
7373
cloudsqlctl start --foreground
7474
```
7575

76+
### Service fails to start (Error 1053)
77+
78+
**Cause**: Usually due to missing credentials or incorrect binary path.
79+
80+
**Solution**:
81+
82+
1. Ensure you have set a Service Account key with `--scope Machine`:
83+
```powershell
84+
cloudsqlctl auth set-service-account --file <path> --scope Machine
85+
```
86+
2. Check the Windows Event Viewer (System logs) for specific service errors.
87+
3. Verify the service configuration:
88+
```powershell
89+
cloudsqlctl service status
90+
```
91+
7692
## Resetting Configuration
7793

7894
If your configuration is corrupted, you can reset the tool to its default state:

0 commit comments

Comments
 (0)