Skip to content

Commit cd4e425

Browse files
roderikroderik
authored
docs: add workspace hierarchy documentation (#555)
## Summary - Added comprehensive documentation for the Workspace Hierarchy feature - Positioned as an enterprise multi-tenant management capability - Included detailed information about parent-child workspace structures, resource sharing, centralized billing, and best practices ## Changes - Created new documentation file: `content/docs/platform-components/account-billing/workspace-hierarchy.mdx` - Updated navigation in `content/docs/platform-components/account-billing/meta.json` to include the new page ## Documentation Coverage The documentation covers: - Parent-Child Workspace Structure - Hierarchical Organization benefits - Resource Sharing across workspaces - Centralized Billing for parent workspaces - Step-by-step setup instructions - Permission inheritance model - Best practices for enterprise multi-tenant management - Example workspace structures for different use cases - Troubleshooting common issues This feature is highlighted as a key enterprise capability for organizations with complex structures requiring sophisticated multi-tenant management. ## Summary by Sourcery Add comprehensive Workspace Hierarchy documentation as an enterprise multi-tenant management feature in the account-billing section Documentation: - Add new Workspace Hierarchy documentation page covering parent-child structures, resource sharing, centralized billing, permission inheritance, setup instructions, best practices, examples, and troubleshooting - Update account-billing navigation meta to include the Workspace Hierarchy page
1 parent 423f319 commit cd4e425

File tree

2 files changed

+357
-1
lines changed

2 files changed

+357
-1
lines changed

‎content/docs/platform-components/account-billing/meta.json‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
11
{
22
"title": "Account & Billing",
3-
"icon": "Wallet"
3+
"icon": "Wallet",
4+
"pages": [
5+
"workspace-hierarchy",
6+
"billing",
7+
"add-a-client",
8+
"join-a-partner"
9+
]
410
}

‎content/docs/platform-components/account-billing/workspace-hierarchy.mdx‎

Lines changed: 350 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,350 @@
1+
---
2+
title: Workspace Hierarchy
3+
description: Enterprise multi-tenant management with hierarchical workspace organization
4+
---
5+
6+
# Workspace Hierarchy
7+
8+
Workspace Hierarchy is an enterprise-grade feature in SettleMint that enables organizations to create and manage complex, multi-tenant structures through parent-child workspace relationships. This powerful capability is designed for enterprises, consortiums, and large organizations that need to maintain clear boundaries between different teams, projects, or subsidiaries while leveraging shared resources and centralized management.
9+
10+
## Overview
11+
12+
The Workspace Hierarchy feature transforms how organizations structure their blockchain initiatives by introducing a parent-child relationship model between workspaces. This hierarchical approach provides the flexibility and control needed for enterprise-scale deployments while maintaining security and isolation where required.
13+
14+
### Key Benefits
15+
16+
- **Organizational Clarity**: Mirror your company's structure with nested workspaces that reflect real-world relationships
17+
- **Resource Efficiency**: Share common resources across child workspaces while maintaining isolation
18+
- **Centralized Management**: Manage billing, permissions, and resources from parent workspaces
19+
- **Scalable Architecture**: Grow your blockchain infrastructure as your organization expands
20+
- **Enhanced Security**: Maintain strict boundaries between different teams or projects
21+
22+
## Parent-Child Workspace Structure
23+
24+
### Understanding the Hierarchy
25+
26+
In SettleMint's workspace hierarchy:
27+
28+
- **Parent Workspaces** act as organizational hubs that can contain multiple child workspaces
29+
- **Child Workspaces** inherit certain properties from their parents while maintaining independence
30+
- **Multiple Levels** of hierarchy are supported, allowing for complex organizational structures
31+
32+
```
33+
Organization (Parent)
34+
├── Development Team (Child)
35+
│ ├── Project Alpha (Grandchild)
36+
│ └── Project Beta (Grandchild)
37+
├── Production Environment (Child)
38+
│ ├── Region US (Grandchild)
39+
│ └── Region EU (Grandchild)
40+
└── Partner Ecosystem (Child)
41+
├── Partner A (Grandchild)
42+
└── Partner B (Grandchild)
43+
```
44+
45+
### Workspace Relationships
46+
47+
Each workspace in the hierarchy maintains:
48+
49+
- **Unique Identity**: Every workspace has its own ID, settings, and configurations
50+
- **Inheritance Model**: Child workspaces can inherit certain configurations from parents
51+
- **Access Boundaries**: Clear permission boundaries between workspaces
52+
- **Resource Isolation**: Option to isolate or share resources based on requirements
53+
54+
## Hierarchical Organization Benefits
55+
56+
### 1. Enterprise Structure Alignment
57+
58+
Workspace hierarchies allow you to:
59+
- Map your organizational chart directly to your blockchain infrastructure
60+
- Create dedicated spaces for different departments, teams, or projects
61+
- Maintain clear separation of concerns while enabling collaboration
62+
63+
### 2. Governance and Compliance
64+
65+
- **Audit Trails**: Track activities across the entire hierarchy from parent workspaces
66+
- **Policy Enforcement**: Apply organization-wide policies from parent levels
67+
- **Compliance Management**: Ensure regulatory requirements are met across all child workspaces
68+
69+
### 3. Development Lifecycle Management
70+
71+
- **Environment Separation**: Maintain distinct development, staging, and production workspaces
72+
- **Progressive Deployment**: Test changes in child workspaces before promoting to parents
73+
- **Version Control**: Manage different versions of applications across the hierarchy
74+
75+
## Resource Sharing Across Workspaces
76+
77+
### Shared Resources
78+
79+
Parent workspaces can share the following resources with their children:
80+
81+
1. **Network Configurations**
82+
- Blockchain network settings
83+
- Node configurations
84+
- Network templates
85+
86+
2. **Security Policies**
87+
- Access control templates
88+
- Security configurations
89+
- Compliance settings
90+
91+
3. **Integration Templates**
92+
- API configurations
93+
- Middleware settings
94+
- External service connections
95+
96+
4. **Development Resources**
97+
- Smart contract libraries
98+
- Code templates
99+
- Development tools
100+
101+
### Resource Isolation
102+
103+
While sharing is powerful, workspace hierarchy also ensures:
104+
- **Data Isolation**: Each workspace maintains its own data boundaries
105+
- **Permission Isolation**: Access controls are workspace-specific
106+
- **Network Isolation**: Option to isolate network resources when needed
107+
108+
## Centralized Billing
109+
110+
### Parent Workspace Billing
111+
112+
One of the most powerful features of workspace hierarchy is centralized billing:
113+
114+
- **Single Invoice**: Receive consolidated billing for all child workspaces
115+
- **Cost Allocation**: Track costs per child workspace for internal chargebacks
116+
- **Budget Management**: Set and monitor budgets across the hierarchy
117+
- **Usage Analytics**: Comprehensive usage reports across all workspaces
118+
119+
### Billing Benefits
120+
121+
1. **Financial Control**
122+
- Centralized cost management
123+
- Predictable budgeting
124+
- Clear cost attribution
125+
126+
2. **Administrative Efficiency**
127+
- Single point of payment
128+
- Simplified vendor management
129+
- Reduced administrative overhead
130+
131+
3. **Cost Optimization**
132+
- Volume discounts across workspaces
133+
- Resource pooling benefits
134+
- Efficient resource allocation
135+
136+
## Setting Up Workspace Hierarchies
137+
138+
### Prerequisites
139+
140+
Before setting up a workspace hierarchy:
141+
- Ensure you have administrative access to the parent workspace
142+
- Plan your organizational structure
143+
- Define resource sharing requirements
144+
- Establish governance policies
145+
146+
### Step-by-Step Setup
147+
148+
1. **Create Parent Workspace**
149+
```
150+
1. Navigate to the SettleMint dashboard
151+
2. Click "Create Workspace"
152+
3. Select "Parent Workspace" option
153+
4. Configure workspace settings
154+
5. Enable hierarchy features
155+
```
156+
157+
2. **Add Child Workspaces**
158+
```
159+
1. From the parent workspace dashboard
160+
2. Click "Add Child Workspace"
161+
3. Define child workspace properties
162+
4. Set inheritance rules
163+
5. Configure resource sharing
164+
```
165+
166+
3. **Configure Relationships**
167+
- Define which resources are shared
168+
- Set permission inheritance rules
169+
- Configure billing relationships
170+
- Establish communication channels
171+
172+
4. **Manage Access Controls**
173+
- Assign workspace administrators
174+
- Define cross-workspace permissions
175+
- Set up authentication methods
176+
- Configure SSO if required
177+
178+
## Permission Inheritance
179+
180+
### Inheritance Model
181+
182+
Permissions in workspace hierarchies follow a sophisticated inheritance model:
183+
184+
1. **Default Inheritance**
185+
- Child workspaces inherit base permissions from parents
186+
- Administrators can override inherited permissions
187+
- Granular control at each level
188+
189+
2. **Permission Types**
190+
- **Administrative**: Full control over workspace
191+
- **Developer**: Create and manage resources
192+
- **Viewer**: Read-only access
193+
- **Custom**: Define specific permission sets
194+
195+
3. **Cross-Workspace Permissions**
196+
- Users can have different roles in different workspaces
197+
- Parent administrators can manage child workspace permissions
198+
- Audit trail for all permission changes
199+
200+
### Managing Permissions
201+
202+
```yaml
203+
Parent Workspace:
204+
Admin:
205+
- Full control
206+
- Manage child workspaces
207+
- Set organization policies
208+
209+
Child Workspace:
210+
Inherited Admin:
211+
- Parent workspace admins
212+
Local Admin:
213+
- Workspace-specific administrators
214+
Developer:
215+
- Create and deploy resources
216+
Viewer:
217+
- Read-only access
218+
```
219+
220+
## Best Practices for Enterprise Multi-Tenant Management
221+
222+
### 1. Organizational Design
223+
224+
- **Plan Before Implementation**: Design your hierarchy based on long-term organizational needs
225+
- **Keep It Simple**: Start with a simple structure and expand as needed
226+
- **Document Everything**: Maintain clear documentation of your hierarchy
227+
228+
### 2. Security Considerations
229+
230+
- **Principle of Least Privilege**: Grant minimum necessary permissions
231+
- **Regular Audits**: Review permissions and access regularly
232+
- **Isolation Strategy**: Clearly define what should be shared vs. isolated
233+
234+
### 3. Resource Management
235+
236+
- **Standardize Configurations**: Use parent workspaces to enforce standards
237+
- **Monitor Usage**: Regular monitoring of resource consumption
238+
- **Optimize Costs**: Leverage shared resources for cost efficiency
239+
240+
### 4. Governance Framework
241+
242+
- **Clear Policies**: Establish and document governance policies
243+
- **Change Management**: Implement proper change control processes
244+
- **Compliance Tracking**: Ensure all workspaces meet compliance requirements
245+
246+
## Example Workspace Structures
247+
248+
### 1. Multi-National Corporation
249+
250+
```
251+
Global HQ (Parent)
252+
├── Americas Division (Child)
253+
│ ├── USA Operations (Grandchild)
254+
│ ├── Canada Operations (Grandchild)
255+
│ └── LATAM Operations (Grandchild)
256+
├── EMEA Division (Child)
257+
│ ├── UK Operations (Grandchild)
258+
│ ├── Germany Operations (Grandchild)
259+
│ └── Middle East Operations (Grandchild)
260+
└── APAC Division (Child)
261+
├── Japan Operations (Grandchild)
262+
├── Singapore Operations (Grandchild)
263+
└── Australia Operations (Grandchild)
264+
```
265+
266+
### 2. Blockchain Consortium
267+
268+
```
269+
Consortium Management (Parent)
270+
├── Founding Members (Child)
271+
│ ├── Member A Workspace (Grandchild)
272+
│ ├── Member B Workspace (Grandchild)
273+
│ └── Member C Workspace (Grandchild)
274+
├── Associate Members (Child)
275+
│ ├── Partner X Workspace (Grandchild)
276+
│ └── Partner Y Workspace (Grandchild)
277+
└── Shared Infrastructure (Child)
278+
├── Common Networks (Grandchild)
279+
└── Shared Services (Grandchild)
280+
```
281+
282+
### 3. Software Development Organization
283+
284+
```
285+
Engineering Organization (Parent)
286+
├── Development Environments (Child)
287+
│ ├── Dev Team A (Grandchild)
288+
│ ├── Dev Team B (Grandchild)
289+
│ └── Innovation Lab (Grandchild)
290+
├── Testing Environments (Child)
291+
│ ├── QA Environment (Grandchild)
292+
│ ├── UAT Environment (Grandchild)
293+
│ └── Performance Testing (Grandchild)
294+
└── Production Systems (Child)
295+
├── Production US (Grandchild)
296+
├── Production EU (Grandchild)
297+
└── DR Environment (Grandchild)
298+
```
299+
300+
## Advanced Features
301+
302+
### Dynamic Resource Allocation
303+
304+
- Automatically allocate resources based on usage patterns
305+
- Scale resources up or down across the hierarchy
306+
- Optimize resource distribution for cost efficiency
307+
308+
### Cross-Workspace Collaboration
309+
310+
- Enable secure data sharing between workspaces
311+
- Implement cross-workspace workflows
312+
- Maintain audit trails for all interactions
313+
314+
### Hierarchical Reporting
315+
316+
- Generate reports at any level of the hierarchy
317+
- Aggregate metrics from child workspaces
318+
- Custom dashboards for different organizational levels
319+
320+
## Troubleshooting Common Issues
321+
322+
### Permission Conflicts
323+
324+
If users experience permission issues:
325+
1. Check inheritance settings
326+
2. Verify local workspace permissions
327+
3. Review audit logs for recent changes
328+
4. Contact parent workspace administrator
329+
330+
### Resource Access Problems
331+
332+
For resource sharing issues:
333+
1. Confirm resource sharing is enabled
334+
2. Check network connectivity between workspaces
335+
3. Verify resource permissions
336+
4. Review resource allocation limits
337+
338+
### Billing Discrepancies
339+
340+
To resolve billing questions:
341+
1. Review child workspace usage reports
342+
2. Check billing configuration in parent workspace
343+
3. Verify cost allocation settings
344+
4. Contact SettleMint support for clarification
345+
346+
## Conclusion
347+
348+
Workspace Hierarchy in SettleMint provides the foundation for enterprise-grade blockchain deployments. By enabling sophisticated organizational structures, resource sharing, and centralized management, it empowers organizations to scale their blockchain initiatives while maintaining control, security, and efficiency.
349+
350+
Whether you're managing a global enterprise, coordinating a multi-party consortium, or overseeing complex development workflows, workspace hierarchies provide the flexibility and control needed for success in enterprise blockchain adoption.

0 commit comments

Comments
 (0)