Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
added suggestions

Co-authored-by: Jelle den Burger <[email protected]>
  • Loading branch information
PolinaSadykova and Jelledb committed Jan 5, 2024
1 parent 42128a6 commit 7146e5b
Show file tree
Hide file tree
Showing 11 changed files with 17 additions and 17 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ meshcloud offers different functionality to people with different roles. To make

* A **User** is a person who uses the meshcloud panel to consume the meshcloud functionality, usually a developer or DevOps engineer. Users are focused on delivering value with their application deployments and use meshcloud to efficiently access, automate and administer the cloud technology they want to use. They want quick access to their deployment spaces and the resources they need. This means avoiding lenghty processes as much as possible, self-service and straight-through processing is key. Users usually work in teams which consists of colleagues of their own organizations or are mixed with external and internal specialists.
* A **Customer** is more a business-oriented role than a *user*. *Customers* have the responsibility for their users and projects in terms of data privacy, security, compliance, cost and capacity management (among others). Think of them as team leads or business managers/product owners with overall responsible for a business application.
* **Partners** has an administrator role. He is resonsible for cloud management in organization by providing meshStack to *customers* and their *users*. Partners can access customers resources to support deployment of resources or to perform other administrative tasks such as cost control, cloud compliance, permossion management etc (some of these roles might be taken by different people than Partners, however we include them to the combined Partner role, as it is represents administrative role).. There is usually a contractual agreement between *partners* and *customers* that defines the obligations and rights of the *partner*.
* **Platform Operators** are also administrative role but with specific technical background and responsibilities for operating and providing cloud technology to *users*, which includes monitoring of cloud operations, intergating platforms, providing cloud services and ensure cloud compliance.
All documentation is split between the User Docs and Administrator Docs. User Docs are more oriented toward basics of meshStack and could be valuble for all roles. Admistrator Docs are solely adressed to Partners and Platform Operators.
* **Partners** have an administrator role. They are responsible for cloud management in the organization by providing meshStack to their internal *customers* / *users*. Partners can access customers' resources to support the deployment of resources or to perform other administrative tasks such as cost control, cloud compliance, permission management, etc (some of these roles might be taken by different people than Partners, however, we include them to the combined Partner role, as it represents an administrative role)..There is usually a contractual agreement between *partners* and *customers* that defines the obligations and rights of the *partner*.
* **Platform Operators** are also an administrative role but with specific technical backgrounds and responsibilities for operating and providing cloud technology to *users*, which include monitoring of cloud operations, integrating platforms, providing cloud services, and ensuring cloud compliance.
All documentation is split between the User Docs and Administrator Docs. User Docs are more oriented toward the basics of meshStack and could be valuable for all roles. Admistrator Docs are solely addressed to Partners and Platform Operators.
## Style Guide for meshcloud Documentation

### Language
Expand Down
2 changes: 1 addition & 1 deletion docs/administration.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Overview
---

Partners Users have access to the so called **Administration Area**. The administration area enables partner users to manage their child [meshWorkspace](./meshcloud.workspace.md) accounts within the meshcloud platform.
Assigning Partner Users can only be done by a **Platform Operator** or Partner Admins.
Assigning Partner Users can only be done by Partner Admins.

Different groups of people may need access to the different administration area functionality. Therefore, the following administrative roles are currently
available to users of the administration area:
Expand Down
2 changes: 1 addition & 1 deletion docs/meshstack.aws.landing-zones.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ This StackSet will be created in every new AWS account. It usually contains simp

### StackSet ARN

Platform Operators can also configure an [CloudFormation StackSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/what-is-cfnstacksets.html) on an AWS Landing Zone. meshStack will then ensure that all AWS Accounts provisioned using this Landing Zone will receive a StackInstance from the StackSet. This allows Partner Operators to leverage that StackSet to centrally manage configuration and resources for all AWS Accounts under the landing zone.
Platform Operators can also configure an [CloudFormation StackSet](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/what-is-cfnstacksets.html) on an AWS Landing Zone. meshStack will then ensure that all AWS Accounts provisioned using this Landing Zone will receive a StackInstance from the StackSet. This allows Platform Operators to leverage that StackSet to centrally manage configuration and resources for all AWS Accounts under the landing zone.

Each AWS project which now gets this Landing Zone assigned will be setup to receive the Cloud Formation Stack Instance setup.

Expand Down
8 changes: 4 additions & 4 deletions docs/meshstack.billing-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ Sometimes Cloud Foundation teams encounter situations in which they need to proc
In case standardisation on a single currency is not possible, meshStack supports chargeback in multiple currencies. The
following product funcitonalities fully support multi-currency scenarios:

- **Private Cloud billing**: Partner can define products and usage rates in any currency.
- **Private Cloud billing**: Partners can define products and usage rates in any currency.
- **Public Cloud billing**: meshStack preserves the original currency when importing cost and consumption data from the cloud provider.
- **meshMarketplace**: Service owners can define prices for their services using the OSB Catalog in any currency.
- **Tenant Usage Reports**: Tenant usage reports support line items in multiple currencies and aggregates net amounts in each currency separately.
- **Chargeback Statements**: Chargeback statements support multiple currencies and aggregate net amounts in each currency separately.
- **Tenant Fees**: Partner can define tenant fees in any currency.
- **Tenant Fees**: Partners can define tenant fees in any currency.
- **Discounts**: Discounts support any currency. Discounts calculated from a source amount (e.g. percentage discounts) use the same currency as the source amount.

The following product functionalitities do currently not support multi-currency scenarios:
Expand Down Expand Up @@ -107,9 +107,9 @@ let example2 =

#### Usage Types and Units

When configuring a product for private cloud billing, Partner need to choose the cloud resource type to target and how the metering engine
When configuring a product for private cloud billing, Partners need to choose the cloud resource type to target and how the metering engine
should generate usages and apply prices to them. The documentation section of each private cloud platform lists the supported resource types and the traits available in the metering engine.
Traits are a properties of a cloud resource like CPU or RAM. Paertner can use traits to configure predicates (filter resources applicable to a pricing rule) and to control how meshMetering calculates usages.
Traits are a properties of a cloud resource like CPU or RAM. Partners can use traits to configure predicates (filter resources applicable to a pricing rule) and to control how meshMetering calculates usages.

meshMetering supports flexible rules for creating usages, like

Expand Down
2 changes: 1 addition & 1 deletion docs/meshstack.cloudfoundry.metering.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ meshStack supports metering and billing for all versions of Cloud Foundry.

## Supported Resources

Resources with the following traits are addressable in the [Product Catalog](meshstack.billing-configuration.md#defining-a-custom-product-catalog).Platform Operators can use the traits of these resources to define fine-granular product and pricing rules.
Resources with the following traits are addressable in the [Product Catalog](meshstack.billing-configuration.md#defining-a-custom-product-catalog). Platform Operators can use the traits of these resources to define fine-granular product and pricing rules.

### Service Instance
<!--snippet:mesh.kraken.productcatalog.traits.cloudfoundry.service.instance#type-->
Expand Down
2 changes: 1 addition & 1 deletion docs/meshstack.gcp.landing-zones.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The [Landing Zone](./meshcloud.landing-zones.md) can be configured in the `Admin

All newly created meshProjects get their corresponding GCP project assigned to this [Folder](https://cloud.google.com/resource-manager/docs/creating-managing-folders) in the [Organization Resource Hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy).

Folders and the application of organization constrains on the projects contained in them through the use of [Organization Policy Service](https://cloud.google.com/resource-manager/docs/organization-policy/overview) can be setup outside of meshcloud by an Platform Operator.
Folders and the application of organization constrains on the projects contained in them through the use of [Organization Policy Service](https://cloud.google.com/resource-manager/docs/organization-policy/overview) can be setup outside of meshcloud by a Platform Operator.

## Template Config URL

Expand Down
4 changes: 2 additions & 2 deletions docs/meshstack.identity-provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: meshstack.identity-provider
title: Identity Provider
---

Platform Operators must be aware of the following requirements and limitations for IdPs serving as identity sources for meshStack.
Partners must be aware of the following requirements and limitations for IdPs serving as identity sources for meshStack.

## Supported Federation Technologies

Expand All @@ -14,7 +14,7 @@ The main supported technologies for Identity Federation with meshStack are
- SAML
- Azure AD

meshStack supports the simultaneous integration of multiple [Enterprise Identity Providers (IdPs)](https://en.wikipedia.org/wiki/Identity_provider) at the Identity Broker. This allows Platform Operators to combine identities from different sources in the platform and unify management of multi-cloud access in meshStack.
meshStack supports the simultaneous integration of multiple [Enterprise Identity Providers (IdPs)](https://en.wikipedia.org/wiki/Identity_provider) at the Identity Broker. This allows Partners to combine identities from different sources in the platform and unify management of multi-cloud access in meshStack.

## User Attribute Requirements

Expand Down
2 changes: 1 addition & 1 deletion docs/meshstack.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The connections are shown in the following matrix table:

## Operations

meshcloud will typically operate your meshStack installation as a [managed service](./meshstack.managed-service.md) for you. As a managed service, all configuration and validation is done by meshcloud. Nonetheless, we make references to configuration options in the documentation so that Platform Operators get a better understanding of meshStack's capabilities. The configuration references also simplify examples and communicate the exact parameters that may need to be supplied by platform operators (e.g. Service Principal credentials).
meshcloud will typically operate your meshStack installation as a [managed service](./meshstack.managed-service.md) for you. As a managed service, all configuration and validation is done by meshcloud. Nonetheless, we make references to configuration options in the documentation so that Partners get a better understanding of meshStack's capabilities. The configuration references also simplify examples and communicate the exact parameters that may need to be supplied by Partners.

### Configuration

Expand Down
2 changes: 1 addition & 1 deletion docs/meshstack.logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ This section overlaps in some parts with the previously mentioned log files, but
| Password changes - Authorization via meshIdB | Keycloak Events, events.log, mesh.log |
| Password changes - Authorization via federated IdP | Federated IdP |
| Access Right changes (i.e. user rights) | Customer/Project Event table, mesh.log |
| Changes to logging configuration (especially deactivation of logging) | Can only be done by an Platform Operator, no logging atm |
| Changes to logging configuration (especially deactivation of logging) | Can only be done by meshcloud, no logging atm |
| Start and stop administrative processes (Batch-Jobs) | mesh.log |

## Structure / Content, Format and Retention
Expand Down
2 changes: 1 addition & 1 deletion docs/meshstack.meshmarketplace.metering.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ and deleted on the first day of reporting period #2 would incur a full charge of

### Configuring "out of scope" Sellers

Platform operators can mark sellers as "out of scope" via configuration. Once a seller is marked as out of scope,
Partners can mark sellers as "out of scope" via configuration. Once a seller is marked as out of scope,
the costs for that seller's products will be set to zero in the meshStack metering product catalog.

The line items for the seller will appear in the usage reports and chargeback statements with an appended "Out of Scope" suffix on the usage type. The total column for those line items will be zero, but the used quantity will be shown correctly.
Expand Down
2 changes: 1 addition & 1 deletion docs/meshstack.tenants.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ meshStack is responsible for creation of [meshTenants](meshcloud.tenant.md) in t

## Reuse of an existing tenant

meshStack does not support reusing platformTenants. Imagine a meshProject has been set as [deleted by an operator](administration.projects.md#delete-projects), but the underlying platform tenant has not been deleted by the Partner. You may think of reusing this tenant in another project by using the [meshObject Import](/api/#mesh_object_declarative_import). This is not supported by meshStack and will lead to an error during import. The reason for this current limitation is handling such a reuse of a tenant in meshMetering. Having the same tenant being used by different projects (perhaps even within the same month), makes it hard or in some cases even impossible to decide which project to charge for this tenant. Therefore reusing platformTenants is currently not supported by meshStack.
meshStack does not support reusing platformTenants. Imagine a meshProject has been set as [deleted by a platform operator](administration.projects.md#delete-projects), but the underlying platform tenant has not been deleted by the platform operator. You may think of reusing this tenant in another project by using the [meshObject Import](/api/#mesh_object_declarative_import). This is not supported by meshStack and will lead to an error during import. The reason for this current limitation is handling such a reuse of a tenant in meshMetering. Having the same tenant being used by different projects (perhaps even within the same month), makes it hard or in some cases even impossible to decide which project to charge for this tenant. Therefore reusing platformTenants is currently not supported by meshStack.

> Read best practices on building a solid tenant management in your cloud foundation on the [cloud foundation website](https://cloudfoundation.org/maturity-model/tenant-management/).
Expand Down

0 comments on commit 7146e5b

Please sign in to comment.