Skip to content

Commit 7cfa327

Browse files
Enhance CF CLI docs: add structure, examples & troubleshootingEnhance CF CLI documentation: improved structure, examples, and troubleshootingImprove Cloud Foundry CLI documentation with enhanced structure and troubleshootingUpdate create-an-sap-cloud-logging-instance-through-cloud-foundry-cli-3658d09.md
Major improvements to the Cloud Foundry CLI documentation: - Enhanced structure with clearer step-by-step instructions - Added common mistakes section with concrete examples - Comprehensive troubleshooting guide with symptoms and actions - Better formatted code examples and prerequisites - Added next steps section for post-creation workflow - Improved readability with bullet points and visual indicators These changes make the documentation more user-friendly and reduce potential configuration errors.
1 parent 5176f0b commit 7cfa327

File tree

1 file changed

+173
-30
lines changed

1 file changed

+173
-30
lines changed
Lines changed: 173 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,194 @@
11
<!-- loio3658d09227dd43c2bcc7df7d774bb925 -->
2-
32
# Create an SAP Cloud Logging Instance through Cloud Foundry CLI
43

5-
6-
7-
8-
94
<a name="loio3658d09227dd43c2bcc7df7d774bb925__section_w5t_wyy_kzb"/>
105

116
## Prerequisites
127

13-
See [Prerequisites](prerequisites-41d8559.md).
8+
Before creating an SAP Cloud Logging instance, ensure you have:
149

10+
- Cloud Foundry CLI installed and configured
11+
- Valid SAP BTP credentials
12+
- Appropriate permissions to create service instances
13+
- Access to a Cloud Foundry space
1514

15+
See [Prerequisites](prerequisites-41d8559.md) for detailed requirements.
1616

1717
<a name="loio3658d09227dd43c2bcc7df7d774bb925__section_ngq_1zy_kzb"/>
1818

1919
## Create a Service Instance
2020

21-
1. `cf marketplace` displays the service in the marketplace.
22-
2. To create a service instance, execute the following command and provide the necessary information:
23-
- `cf create-service cloud-logging <service-plan> <instance_name> -c <parameters>`.
24-
- See [Service Plans](service-plans-a9d2d1b.md) and [Configuration Parameters](configuration-parameters-1830bca.md) for configuration options.
25-
- Here is an example command with additional parameters:
21+
Follow these steps to create your SAP Cloud Logging service instance:
22+
23+
### Step 1: Verify Service Availability
24+
25+
First, check that the SAP Cloud Logging service is available in the marketplace:
26+
27+
```bash
28+
cf marketplace
29+
```
30+
31+
Look for `cloud-logging` in the service list. If it's not visible:
32+
- **Check your org/space**: Ensure you're targeting the correct org and space
33+
- **Verify entitlements**: Confirm your subaccount has the necessary service entitlements
34+
- **Contact administrator**: Request access if the service is not entitled
35+
36+
### Step 2: Create the Service Instance
37+
38+
#### Basic Command Structure
39+
40+
```bash
41+
cf create-service cloud-logging <service_plan> <instance_name> [-c <parameters>]
42+
```
43+
44+
**Parameters:**
45+
- `<service_plan>`: Choose from available plans (see [Service Plans](service-plans-a9d2d1b.md))
46+
- `<instance_name>`: Your custom name for the instance
47+
- `<parameters>`: Optional JSON configuration (see [Configuration Parameters](configuration-parameters-1830bca.md))
48+
49+
#### Basic Example
50+
51+
```bash
52+
cf create-service cloud-logging standard my-logging-instance
53+
```
54+
55+
#### Advanced Example with Configuration
56+
57+
```bash
58+
cf create-service cloud-logging standard my-logging-instance -c '{
59+
"retention_period": 14,
60+
"backend": {
61+
"max_data_nodes": 10,
62+
"api_enabled": false
63+
},
64+
"ingest": {
65+
"max_instances": 10
66+
}
67+
}'
68+
```
69+
70+
### Step 3: Monitor Provisioning Progress
71+
72+
#### Check Service Status
73+
74+
Monitor the provisioning process:
75+
76+
```bash
77+
cf services
78+
```
79+
80+
Look for your service instance in the output. The `last operation` column shows the current status.
81+
82+
#### Wait for Completion
83+
84+
- **Status "create in progress"**: Wait for provisioning to complete
85+
- **Status "create succeeded"**: Instance is ready for use
86+
- **Status "create failed"**: See troubleshooting section below
87+
88+
## Common Mistakes and Solutions
89+
90+
### ❌ Missing Service Plan
91+
92+
**Error:** `Service plan is required`
93+
94+
**Solution:** Always specify a service plan:
95+
```bash
96+
# Wrong
97+
cf create-service cloud-logging my-instance
98+
99+
# Correct
100+
cf create-service cloud-logging standard my-instance
101+
```
102+
103+
### ❌ Invalid JSON Configuration
104+
105+
**Error:** `Invalid JSON in -c parameter`
106+
107+
**Solution:** Validate your JSON syntax:
108+
```bash
109+
# Wrong (missing quotes)
110+
cf create-service cloud-logging standard my-instance -c '{retention_period: 14}'
111+
112+
# Correct
113+
cf create-service cloud-logging standard my-instance -c '{"retention_period": 14}'
114+
```
115+
116+
### ❌ Insufficient Permissions
117+
118+
**Error:** `Access is denied`
119+
120+
**Solution:**
121+
- Verify you're assigned the SpaceDeveloper role
122+
- Check org and space permissions
123+
- Contact your BTP administrator
124+
125+
### ❌ Service Already Exists
126+
127+
**Error:** `Service instance already exists`
128+
129+
**Solution:** Choose a different instance name or delete the existing instance:
130+
```bash
131+
cf delete-service existing-instance-name
132+
```
133+
134+
## Troubleshooting
135+
136+
### Provisioning Takes Too Long
137+
138+
**Symptoms:** Service stuck in "create in progress" for more than 15 minutes
139+
140+
**Actions:**
141+
1. Check BTP cockpit for service instance status
142+
2. Verify quota and entitlements
143+
3. Try creating with minimal configuration first
144+
4. Contact SAP support if issue persists
145+
146+
### Configuration Parameter Errors
147+
148+
**Symptoms:** Service creation fails with configuration-related errors
149+
150+
**Actions:**
151+
1. Validate JSON syntax using online JSON validators
152+
2. Check parameter names against [Configuration Parameters](configuration-parameters-1830bca.md)
153+
3. Start with basic configuration and add parameters incrementally
154+
4. Review parameter value ranges and restrictions
155+
156+
### Service Not Available in Marketplace
157+
158+
**Symptoms:** `cloud-logging` not listed in `cf marketplace`
159+
160+
**Actions:**
161+
1. Verify you're in the correct org/space:
162+
```bash
163+
cf target
164+
```
165+
2. Check service entitlements in BTP cockpit
166+
3. Switch to entitled org/space:
167+
```bash
168+
cf target -o <org> -s <space>
169+
```
26170

27-
```
28-
cf create-service cloud-logging standard cloud-logging -c '{
29-
"retention_period": 14,
30-
"backend": {
31-
"max_data_nodes": 10,
32-
"api_enabled": false
33-
},
34-
"ingest": {
35-
"max_instances": 10
36-
}
37-
}'
38-
39-
```
171+
### Quota Exceeded
40172

173+
**Symptoms:** Error about quota limits
41174

42-
3. Wait for your dedicated instance to be provisioned.
43-
- Use the following command to verify the service provisioning. This checks the `last operation` status:
175+
**Actions:**
176+
1. Check current service usage:
177+
```bash
178+
cf services
179+
```
180+
2. Review quota in BTP cockpit
181+
3. Delete unused service instances
182+
4. Request quota increase from administrator
44183

45-
```
46-
cf services
47-
```
184+
## Next Steps
48185

49-
- Wait until the last operation reads `create succeeded`. The service instance is now available for consumption.
186+
After successful creation:
50187

188+
1. **Verify instance**: Check that your service appears in `cf services` with status "create succeeded"
189+
2. **Create service key**: Generate credentials for application binding
190+
3. **Configure applications**: Bind the service to your applications
191+
4. **Test connectivity**: Verify logging data ingestion
51192

193+
For detailed configuration options, see [Configuration Parameters](configuration-parameters-1830bca.md).
194+
For different service plans, see [Service Plans](service-plans-a9d2d1b.md).

0 commit comments

Comments
 (0)