diff --git a/content/en/docs/dependencies/_index.md b/content/en/docs/dependencies/_index.md index 61a7e060..b06f5d66 100644 --- a/content/en/docs/dependencies/_index.md +++ b/content/en/docs/dependencies/_index.md @@ -30,23 +30,8 @@ containers: resources: env: type: environment - properties: - NAME: - type: string - default: World db: type: postgres - properties: - host: - default: localhost - port: - default: 5432 - name: - default: postgres - user: - secret: true - password: - secret: true service-b: type: workload ``` @@ -70,10 +55,6 @@ containers: resources: env: type: environment - properties: - NAME: - type: string - default: World ``` To prepare the Docker Compose configuration files, convert both Score files with `score-compose`. diff --git a/content/en/docs/dependencies/dependencies-humanitec.md b/content/en/docs/dependencies/dependencies-humanitec.md index 2827e439..1ace96eb 100644 --- a/content/en/docs/dependencies/dependencies-humanitec.md +++ b/content/en/docs/dependencies/dependencies-humanitec.md @@ -43,25 +43,10 @@ containers: resources: db: type: postgres - properties: - host: - default: localhost - port: - default: 5432 - name: - default: postgres - user: - secret: true - password: - secret: true dns: type: dns - properties: - domain: backend: type: workload - properties: - name: ``` This example also uses an extensions file, called `humanitec.yaml`, that contains additional hints for `score-humanitec` CLI tool. This information would help the CLI tool to resolve the resources properly. diff --git a/content/en/docs/environment variables/environment-variables-compose.md b/content/en/docs/environment variables/environment-variables-compose.md index 3e3b2721..efa4a7fb 100644 --- a/content/en/docs/environment variables/environment-variables-compose.md +++ b/content/en/docs/environment variables/environment-variables-compose.md @@ -36,10 +36,6 @@ containers: resources: env: type: environment - properties: - NAME: - type: string - default: World ``` Use the `run` command to generate a Docker Compose file from Score. diff --git a/content/en/docs/environment variables/environment-variables-helm.md b/content/en/docs/environment variables/environment-variables-helm.md index ba0f3b4b..20ab6b62 100644 --- a/content/en/docs/environment variables/environment-variables-helm.md +++ b/content/en/docs/environment variables/environment-variables-helm.md @@ -31,10 +31,6 @@ containers: resources: env: type: environment - properties: - NAME: - type: string - default: World ``` {{% alert %}} diff --git a/content/en/docs/environment variables/environment-variables-humanitec.md b/content/en/docs/environment variables/environment-variables-humanitec.md index 7ae3c98e..ed21877d 100644 --- a/content/en/docs/environment variables/environment-variables-humanitec.md +++ b/content/en/docs/environment variables/environment-variables-humanitec.md @@ -29,10 +29,6 @@ containers: resources: env: type: environment - properties: - NAME: - type: string - default: World ``` {{% alert %}} diff --git a/content/en/docs/extensions/_index.md b/content/en/docs/extensions/_index.md index 812d0172..cf0ff269 100644 --- a/content/en/docs/extensions/_index.md +++ b/content/en/docs/extensions/_index.md @@ -70,14 +70,8 @@ containers: resources: dns: type: dns - properties: - domain: - ... api-route: type: route - properties: - prefix: - ... ``` ## Humanitec Workload implementation diff --git a/content/en/docs/extensions/implement-ports-volumes.md b/content/en/docs/extensions/implement-ports-volumes.md index f2ed5be8..03391687 100644 --- a/content/en/docs/extensions/implement-ports-volumes.md +++ b/content/en/docs/extensions/implement-ports-volumes.md @@ -31,11 +31,6 @@ containers: resources: env: type: environment - properties: - MESSAGE: - type: string - DATADOG_ENV: - type: string dns: type: dns ``` diff --git a/content/en/docs/get started/Transform/_index.md b/content/en/docs/get started/Transform/_index.md deleted file mode 100644 index 915fe836..00000000 --- a/content/en/docs/get started/Transform/_index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "Run your first transform" -linkTitle: "Run your first transform" -weight: 4 -draft: true -description: > - This section contains pages that show how to apply a transformation on your Score Specification file. ---- - -Throughout the following sections. You will learn how to run a transform in the following formats: - - diff --git a/content/en/docs/get started/Transform/docker.md b/content/en/docs/get started/Transform/docker.md deleted file mode 100644 index 21b9bdcd..00000000 --- a/content/en/docs/get started/Transform/docker.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: "Compose" -linkTitle: "Compose" -weight: 4 -description: > - Learn to translate a Score Specification file into a Docker Compose configuration with the target Score implementation tool. ---- - -{{% alert %}} - -> If at any point you need help, `score-compose --help` from your terminal. -> {{% /alert %}} - -In this walkthrough you will: - -- 1 -- 2 -- 3 - -Getting started: -Start files -End files - -### Prerequisites: Set up - -1. Install the `score-compose` target Score implementation tool. - -## Step 1. Author your score file - -1. Declare your resources. - 1. In this example, we will use a Postgres database. - -```yaml -resources: -db: - type: postgres -``` - -1. Add properties. - -```yaml -properties: - host: - default: localhost - port: - default: 5432 - name: - username: - secret: true - password: - secret: true -``` - -1. Declare your dependencies -2. Add environment variables. - -## Step 2. Run the target Score implementation tool - -Choose from one of the following options: - -1. `score-compose` -2. `score-helm` -3. `score-humanitec` - -## Step 3. ? - -## Step 4. Push to CI - -By default, `--file` defaults to `./score.yaml` and `--output` defaults to `./compose.yaml`. - -The following is the expected output from the previous command. - -```bash -Reading './score.yaml'... -Parsing score spec... -Building docker compose configuration... -Creating './compose.yaml'... -Writing docker compose configuration... -``` - -The following is the output of the run command. - -```yaml -services: - hello-world: {} -``` - -**Results**: You've successfully transformed a Score Specification file into a Docker Compose configuration. diff --git a/content/en/docs/get started/Transform/helm.md b/content/en/docs/get started/Transform/helm.md deleted file mode 100644 index f8df3848..00000000 --- a/content/en/docs/get started/Transform/helm.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "Helm" -linkTitle: "Helm" -weight: 4 -description: > - Learn to translate a Score Specification file into a Helm configuration with the target Score implementation tool. ---- - -{{% alert %}} - -> If at any point you need help, `score-helm --help` from your terminal. -> {{% /alert %}} - -The Score Specification file configures into Helm values, including containers, dependencies, and other Helm specific values. - -These values are combined with a pre-built Helm directory that are shipped with the application by default. -The `score-helm run` command produces a valid `values.yaml` file that can be distributed or deployed. - -