Add doc's for SCF resources

Author: fapo85

docs/data-sources/scf_organization.md

@@ -0,0 +1,43 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "stackit_scf_organization Data Source - stackit"
+subcategory: ""
+description: |-
+  STACKIT Cloud Foundry organization datasource schema. Must have a region specified in the provider configuration.
+---
+
+# stackit_scf_organization (Data Source)
+
+STACKIT Cloud Foundry organization datasource schema. Must have a `region` specified in the provider configuration.
+
+## Example Usage
+
+```terraform
+data "stackit_scf_organization" "example" {
+  guid       = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+  project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `org_id` (String) The ID of the organization
+- `project_id` (String) The ID of the project associated with the organization
+
+### Optional
+
+- `platform_id` (String) The ID of the platform associated with the organization
+- `quota_id` (String) The ID of the quota associated with the organization
+- `region` (String) The region where the organization is located
+- `suspended` (Boolean) A boolean indicating whether the organization is suspended
+
+### Read-Only
+
+- `created_at` (String) The time when the organization was created
+- `id` (String) Terraform's internal resource ID, structured as "`project_id`,`org_id`".
+- `name` (String) The name of the organization
+- `status` (String) The status of the organization (e.g., deleting, delete_failed)
+- `updated_at` (String) The time when the organization was last updated

docs/data-sources/scf_organization_manager.md

@@ -0,0 +1,35 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "stackit_scf_organization_manager Data Source - stackit"
+subcategory: ""
+description: |-
+  STACKIT Cloud Foundry organization manager datasource schema. Must have a region specified in the provider configuration.
+---
+
+# stackit_scf_organization_manager (Data Source)
+
+STACKIT Cloud Foundry organization manager datasource schema. Must have a `region` specified in the provider configuration.
+
+
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `org_id` (String) The ID of the organization
+- `project_id` (String) The ID of the project associated with the organization of the organization manager
+
+### Optional
+
+- `region` (String) The region where the organization of the organization manager is located
+
+### Read-Only
+
+- `created_at` (String) The time when the organization manager was created
+- `id` (String) Terraform's internal resource ID, structured as "`project_id`,`org_id`,`user_id`".
+- `password` (String) An auto-generated password
+- `platform_id` (String) The ID of the platform associated with the organization of the organization manager
+- `updated_at` (String) The time when the organization manager was last updated
+- `user_id` (String) The ID of the organization manager user
+- `username` (String) An auto-generated organization manager user name

docs/data-sources/scf_platform.md

@@ -0,0 +1,37 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "stackit_scf_platform Data Source - stackit"
+subcategory: ""
+description: |-
+  STACKIT Cloud Foundry Platform datasource schema.
+---
+
+# stackit_scf_platform (Data Source)
+
+STACKIT Cloud Foundry Platform datasource schema.
+
+## Example Usage
+
+```terraform
+data "stackit_scf_platform" "example" {
+  guid       = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+  project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `guid` (String) The unique id of the platform
+- `project_id` (String) The ID of the project associated with the platform
+
+### Read-Only
+
+- `api_url` (String) The CF API Url of the platform
+- `console_url` (String) The Stratos URL of the platform
+- `display_name` (String) The name of the platform
+- `id` (String) Terraform's internal resource ID, structured as "`project_id`,`guid`".
+- `region` (String) The region where the platform is located
+- `system_id` (String) The ID of the platform System

docs/guides/scf_cloudfoundry.md

@@ -7,34 +7,36 @@ integrating the STACKIT Terraform provider with the Cloud Foundry Terraform
 provider. The STACKIT Terraform provider will create a managed Cloud Foundry
 organization and set up a technical "org manager" user with
 `organization_manager` permissions. These credentials, along with the Cloud
-Foundry API URL (retrieved dynamically from a platform data resource), will then
-be passed to the Cloud Foundry Terraform provider to manage resources within the
-newly created organization.
+Foundry API URL (retrieved dynamically from a platform data resource), are
+passed to the Cloud Foundry Terraform provider to manage resources within the
+new organization.
 
 ### Output
 
-The example configuration provisions a Cloud Foundry organization, mirroring the
-structure created via the portal. It sets up three distinct spaces: `dev`, `qa`,
-and `prod`. Furthermore, a specified user is assigned the `organization_manager`
+This configuration creates a Cloud Foundry organization, mirroring the structure
+created via the portal. It sets up three distinct spaces: `dev`, `qa`, and
+`prod`. The configuration assigns, a specified user the `organization_manager`
 and `organization_user` roles at the organization level, and the
-`space_developer` role within each of the `dev`, `qa`, and `prod` spaces.
+`space_developer` role in each space.
 
-### Outside of the scope
+### Scope
 
-This tutorial focuses specifically on the interaction between the STACKIT
-Terraform provider and the Cloud Foundry Terraform provider. It assumes
-familiarity with:
+This tutorial covers the interaction between the STACKIT Terraform provider and
+the Cloud Foundry Terraform provider. It assumes you are familiar with:
 
 - Setting up a STACKIT project and configuring the STACKIT Terraform provider
-  with a service account (details for which can be found in the general STACKIT
-  documentation).
+  with a service account (see the general STACKIT documentation for details).
 - Basic Terraform concepts, such as variables and locals.
 
-Therefore, this document will not delve into these foundational topics, nor will
-it cover every feature offered by the Cloud Foundry Terraform provider.
+This document does not cover foundational topics or every feature of the Cloud
+Foundry Terraform provider.
 
 ### Example configuration
 
+The following Terraform configuration provisions a Cloud Foundry organization
+and related resources using the STACKIT Terraform provider and the Cloud Foundry
+Terraform provider:
+
 ```
 terraform {
   required_providers {
@@ -118,26 +120,26 @@ resource "cloudfoundry_space_role" "space_developer" {
 }
 ```
 
-## Taken apart
+## Explanation of configuration
 
-### STACKIT Provider Configuration
+### STACKIT provider configuration
 
 ```
 provider "stackit" {
   default_region           = "eu01"
 }
 ```
 
-The SCF API is regionalized to ensure fault isolation, meaning each region
-operates independently. For this reason, we set `default_region` in the provider
-configuration, which applies to all resources unless explicitly overridden.
-Additionally, appropriate access data for the corresponding STACKIT project must
-be provided for the provider to function.
+The STACKIT Cloud Foundry Application Programming Interface (SCF API) is
+regionalized. Each region operates independently. Set `default_region` in the
+provider configuration, to specify the region for all resources, unless you
+override it for individual resources. You must also provide access data for the
+relevant STACKIT project for the provider to function.
 
-See:
-[STACKIT Terraform Provider Documentation](https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs)
+For more details, see
+the:[STACKIT Terraform Provider documentation.](https://registry.terraform.io/providers/stackitcloud/stackit/latest/docs)
 
-### stackit_scf_organization.scf_org
+### stackit_scf_organization.scf_org resource
 
 ```
 resource "stackit_scf_organization" "scf_org" {
@@ -146,15 +148,15 @@ resource "stackit_scf_organization" "scf_org" {
 }
 ```
 
-This resource provisions the Cloud Foundry organization, which serves as the
-foundational container within the Cloud Foundry environment. Each Cloud Foundry
-provider configuration is scoped to a specific organization. The organization's
-name, defined by a variable, must be unique across the platform. This
-organization is created within a designated STACKIT project, requiring the
+This resource provisions a Cloud Foundry organization, which acts as the
+foundational container in the Cloud Foundry environment. Each Cloud Foundry
+provider configuration is scoped to a specific organization. The organization’s
+name, defined by a variable, must be unique across the platform. The
+organization is created within a designated STACKIT project, which requires the
 STACKIT provider to be configured with the necessary permissions for that
 project.
 
-### stackit_scf_organization_manager.scf_manager
+### stackit_scf_organization_manager.scf_manager resource
 
 ```
 resource "stackit_scf_organization_manager" "scf_manager" {
@@ -163,13 +165,11 @@ resource "stackit_scf_organization_manager" "scf_manager" {
 }
 ```
 
-This resource creates a technical user within the Cloud Foundry Organization,
-designated as an "organization manager." This user is intrinsically linked to
-the organization and will be automatically deleted when the organization is
-removed. The user is assigned the `organization_manager` permission within the
-Cloud Foundry organization.
+This resource creates a technical user in the Cloud Foundry organization with
+the organization_manager permission. The user is linked to the organization and
+is automatically deleted when the organization is removed.
 
-### stackit_scf_platform.scf_platform
+### stackit_scf_platform.scf_platform data source
 
 ```
 data "stackit_scf_platform" "scf_platform" {
@@ -179,10 +179,10 @@ data "stackit_scf_platform" "scf_platform" {
 ```
 
 This data source retrieves properties of the Cloud Foundry platform where the
-organization is provisioned. It does not create any resources within the
-project, but rather provides information about an existing platform.
+organization is provisioned. It does not create resources, but provides
+information about the existing platform.
 
-### Cloud Foundry Provider Configuration
+### Cloud Foundry provider configuration
 
 ```
 provider "cloudfoundry" {
@@ -192,53 +192,57 @@ provider "cloudfoundry" {
 }
 ```
 
-The Cloud Foundry provider is configured to manage resources within the newly
-created organization. It uses the API URL retrieved from the
-`stackit_scf_platform` data source to communicate with the Cloud Foundry
-platform and authenticates using the credentials of the
-`stackit_scf_organization_manager` technical user.
+The Cloud Foundry provider is configured to manage resources in the new
+organization. The provider uses the API URL from the `stackit_scf_platform` data
+source and authenticates using the credentials of the technical user created by
+the `stackit_scf_organization_manager` resource.
+
+For more information, see the:
+[Cloud Foundry Terraform Provider documentation.](https://registry.terraform.io/providers/cloudfoundry/cloudfoundry/latest/docs)
+
+## Deploy resources
 
-See:
-[Cloud Foundry Terraform Provider Documentation](https://registry.terraform.io/providers/cloudfoundry/cloudfoundry/latest/docs)
+Follow these steps to initialize your environment and provision Cloud Foundry
+resources using Terraform.
 
-## Deployment
+### Initialize Terraform
 
-### init
+Run the following command to initialize the working directory and download the
+required provider plugins:
 
 ```
 terraform init
 ```
 
-The `terraform init` command initializes the working directory and downloads the
-necessary provider plugins.
+### Create the organization manager user
 
-### Create Initial Resources
+Run this command to provision the organization and technical user needed to
+initialize the Cloud Foundry Terraform provider. This step is required only
+during the initial setup. For later changes, you do not need the -target flag.
 
 ```
 terraform apply -target stackit_scf_organization_manager.scf_manager
 ```
 
-This initial `terraform apply` command provisions the resources required to
-initialize the Cloud Foundry Terraform provider. This step is only required for
-the initial setup; subsequent `terraform apply` commands that modify resources
-within the Cloud Foundry organization do not require the `-target` flag.
+### Apply the full configuration
 
-### Apply Complete Configuration
+Run this command to provision all resources defined in your Terraform
+configuration within the Cloud Foundry organization:
 
 ```
 terraform apply
 ```
 
-This command applies the complete Terraform configuration, provisioning all
-defined resources within the Cloud Foundry organization.
-
-## Verification
-
-To verify the deployment, use the `cf apps`, `cf services`, and `cf routes`
-commands.
+## Verify the deployment
 
-see:
+Verify that your Cloud Foundry resources are provisioned correctly. Use the
+following Cloud Foundry CLI commands to check applications, services, and
+routes:
 
-[Cloud Foundry Documentation](https://docs.cloudfoundry.org/)
+- `cf apps`
+- `cf services`
+- `cf routes`
 
-[Cloud Foundry CLI Reference Guide](https://cli.cloudfoundry.org/)
+For more information, see the
+[Cloud Foundry documentation](https://docs.cloudfoundry.org/) and the
+[Cloud Foundry CLI Reference Guide](https://cli.cloudfoundry.org/).

docs/index.md

@@ -177,6 +177,7 @@ Note: AWS specific checks must be skipped as they do not work on STACKIT. For de
 - `redis_custom_endpoint` (String) Custom endpoint for the Redis service
 - `region` (String, Deprecated) Region will be used as the default location for regional services. Not all services require a region, some are global
 - `resourcemanager_custom_endpoint` (String) Custom endpoint for the Resource Manager service
+- `scf_custom_endpoint` (String) Custom endpoint for the Cloud Foundry (SCF) service
 - `secretsmanager_custom_endpoint` (String) Custom endpoint for the Secrets Manager service
 - `server_backup_custom_endpoint` (String) Custom endpoint for the Server Backup service
 - `server_update_custom_endpoint` (String) Custom endpoint for the Server Update service