Skip to content

Commit

Permalink
Documentation for new deck command kong2tf (#7899)
Browse files Browse the repository at this point in the history
  • Loading branch information
@battlebyte
battlebyte authored Sep 13, 2024
1 parent c0c079a commit 1cca572
Show file tree
Hide file tree
Showing 6 changed files with 1,113 additions and 0 deletions.
146 changes: 146 additions & 0 deletions app/_data/docs_nav_deck_1.40.x.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
product: deck
release: 1.40.x
generate: true
items:
- title: Introduction
icon: /assets/images/icons/documentation/icn-flag.svg
url: /deck/1.40.x/
absolute_url: true
items:
- text: Terminology
url: /terminology/
- text: Architecture
url: /design-architecture/
- text: Use Case - Streamlining KongAir APIs
url: /use-case/
- text: Compatibility Promise
url: /compatibility-promise/

- title: Changelog
icon: /assets/images/icons/documentation/icn-references-color.svg
url: https://github.com/kong/deck/blob/main/CHANGELOG.md
absolute_url: true

- title: Installation
icon: /assets/images/icons/documentation/icn-deployment-color.svg
url: /installation

- title: Guides
icon: /assets/images/icons/documentation/icn-solution-guide.svg
items:
- text: Getting Started with decK
url: /guides/getting-started/
- text: Backup and Restore
url: /guides/backup-restore/
- text: Upgrade to Kong Gateway 3.x
url: /3.0-upgrade/
- text: Configuration as Code and GitOps
url: /guides/ci-driven-configuration/
- text: APIOps with decK
url: /guides/apiops/
- text: Distributed Configuration
url: /guides/distributed-configuration/
- text: Best Practices
url: /guides/best-practices/
- text: Using decK with Kong Gateway (Enterprise)
url: /guides/kong-enterprise/
- text: Using decK with Konnect
url: /guides/konnect/
- text: Run decK with Docker
url: /guides/run-with-docker/
src: /deck/guides/run-with-docker-1.28
- text: Using Multiple Files to Store Configuration
url: /guides/multi-file-state/
- text: De-duplicate Plugin Configuration
url: /guides/deduplicate-plugin-configuration/
- text: Set Up Object Defaults
url: /guides/defaults/
- text: Security
items:
- text: Overview
url: /guides/security/
- text: Secret Management with decK
url: /guides/vaults/
- text: Using Environment Variables with decK
url: /guides/environment-variables/

- title: Reference
icon: /assets/images/icons/documentation/icn-references-color.svg
items:
- text: Entities Managed by decK
url: /reference/entities/
- text: decK CLI
url: /reference/deck/
- text: deck completion
url: /reference/deck_completion/
- text: deck file commands
items:
- text: deck file
url: /reference/deck_file/
- text: deck file add-plugins
url: /reference/deck_file_add-plugins/
- text: deck file add-tags
url: /reference/deck_file_add-tags/
- text: deck file convert
url: /reference/deck_file_convert/
- text: deck file kong2kic
url: /reference/deck_file_kong2kic/
- text: deck file kong2tf
url: /reference/deck_file_kong2tf/
- text: deck file lint
url: /reference/deck_file_lint/
- text: deck file list-tags
url: /reference/deck_file_list-tags/
- text: deck file merge
url: /reference/deck_file_merge/
- text: deck file namespace
url: /reference/deck_file_namespace/
- text: deck file openapi2kong
url: /reference/deck_file_openapi2kong/
- text: deck file patch
url: /reference/deck_file_patch/
- text: deck file remove-tags
url: /reference/deck_file_remove-tags/
- text: deck file render
url: /reference/deck_file_render/
- text: deck file validate
url: /reference/deck_file_validate/
- text: deck gateway commands
items:
- text: deck gateway
url: /reference/deck_gateway/
- text: deck gateway diff
url: /reference/deck_gateway_diff/
- text: deck gateway dump
url: /reference/deck_gateway_dump/
- text: deck gateway ping
url: /reference/deck_gateway_ping/
- text: deck gateway reset
url: /reference/deck_gateway_reset/
- text: deck gateway sync
url: /reference/deck_gateway_sync/
- text: deck gateway validate
url: /reference/deck_gateway_validate/
- text: deck version
url: /reference/deck_version/
- text: Deprecated commands
items:
- text: deck convert
url: /reference/deck_convert/
- text: deck diff
url: /reference/deck_diff/
- text: deck dump
url: /reference/deck_dump/
- text: deck ping
url: /reference/deck_ping/
- text: deck reset
url: /reference/deck_reset/
- text: deck sync
url: /reference/deck_sync/
- text: deck validate
url: /reference/deck_validate/


- title: FAQ
icon: /assets/images/icons/documentation/icn-faq-color.svg
url: /faqs/
146 changes: 146 additions & 0 deletions app/_data/docs_nav_deck_1.41.x.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
product: deck
release: 1.41.x
generate: true
items:
- title: Introduction
icon: /assets/images/icons/documentation/icn-flag.svg
url: /deck/1.41.x/
absolute_url: true
items:
- text: Terminology
url: /terminology/
- text: Architecture
url: /design-architecture/
- text: Use Case - Streamlining KongAir APIs
url: /use-case/
- text: Compatibility Promise
url: /compatibility-promise/

- title: Changelog
icon: /assets/images/icons/documentation/icn-references-color.svg
url: https://github.com/kong/deck/blob/main/CHANGELOG.md
absolute_url: true

- title: Installation
icon: /assets/images/icons/documentation/icn-deployment-color.svg
url: /installation

- title: Guides
icon: /assets/images/icons/documentation/icn-solution-guide.svg
items:
- text: Getting Started with decK
url: /guides/getting-started/
- text: Backup and Restore
url: /guides/backup-restore/
- text: Upgrade to Kong Gateway 3.x
url: /3.0-upgrade/
- text: Configuration as Code and GitOps
url: /guides/ci-driven-configuration/
- text: APIOps with decK
url: /guides/apiops/
- text: Distributed Configuration
url: /guides/distributed-configuration/
- text: Best Practices
url: /guides/best-practices/
- text: Using decK with Kong Gateway (Enterprise)
url: /guides/kong-enterprise/
- text: Using decK with Konnect
url: /guides/konnect/
- text: Run decK with Docker
url: /guides/run-with-docker/
src: /deck/guides/run-with-docker-1.28
- text: Using Multiple Files to Store Configuration
url: /guides/multi-file-state/
- text: De-duplicate Plugin Configuration
url: /guides/deduplicate-plugin-configuration/
- text: Set Up Object Defaults
url: /guides/defaults/
- text: Security
items:
- text: Overview
url: /guides/security/
- text: Secret Management with decK
url: /guides/vaults/
- text: Using Environment Variables with decK
url: /guides/environment-variables/

- title: Reference
icon: /assets/images/icons/documentation/icn-references-color.svg
items:
- text: Entities Managed by decK
url: /reference/entities/
- text: decK CLI
url: /reference/deck/
- text: deck completion
url: /reference/deck_completion/
- text: deck file commands
items:
- text: deck file
url: /reference/deck_file/
- text: deck file add-plugins
url: /reference/deck_file_add-plugins/
- text: deck file add-tags
url: /reference/deck_file_add-tags/
- text: deck file convert
url: /reference/deck_file_convert/
- text: deck file kong2kic
url: /reference/deck_file_kong2kic/
- text: deck file kong2tf
url: /reference/deck_file_kong2tf/
- text: deck file lint
url: /reference/deck_file_lint/
- text: deck file list-tags
url: /reference/deck_file_list-tags/
- text: deck file merge
url: /reference/deck_file_merge/
- text: deck file namespace
url: /reference/deck_file_namespace/
- text: deck file openapi2kong
url: /reference/deck_file_openapi2kong/
- text: deck file patch
url: /reference/deck_file_patch/
- text: deck file remove-tags
url: /reference/deck_file_remove-tags/
- text: deck file render
url: /reference/deck_file_render/
- text: deck file validate
url: /reference/deck_file_validate/
- text: deck gateway commands
items:
- text: deck gateway
url: /reference/deck_gateway/
- text: deck gateway diff
url: /reference/deck_gateway_diff/
- text: deck gateway dump
url: /reference/deck_gateway_dump/
- text: deck gateway ping
url: /reference/deck_gateway_ping/
- text: deck gateway reset
url: /reference/deck_gateway_reset/
- text: deck gateway sync
url: /reference/deck_gateway_sync/
- text: deck gateway validate
url: /reference/deck_gateway_validate/
- text: deck version
url: /reference/deck_version/
- text: Deprecated commands
items:
- text: deck convert
url: /reference/deck_convert/
- text: deck diff
url: /reference/deck_diff/
- text: deck dump
url: /reference/deck_dump/
- text: deck ping
url: /reference/deck_ping/
- text: deck reset
url: /reference/deck_reset/
- text: deck sync
url: /reference/deck_sync/
- text: deck validate
url: /reference/deck_validate/


- title: FAQ
icon: /assets/images/icons/documentation/icn-faq-color.svg
url: /faqs/
6 changes: 6 additions & 0 deletions app/_data/kong_versions.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,12 @@
- release: "1.39.x"
version: "1.39.0"
edition: "deck"
- release: "1.40.x"
version: "1.40.0"
edition: "deck"
- release: "1.41.x"
version: "1.41.0"
edition: "deck"
label: unreleased
- edition: "konnect"
- edition: "contributing"
Expand Down
3 changes: 3 additions & 0 deletions app/_includes/md/deck-reference-links.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ File subcommands:
{% if_version gte:1.35.x -%}
* [deck file kong2kic](/deck/{{page.release}}/reference/deck_file_kong2kic) - Convert decK state files to Kong Ingress Controller kubernetes manifests.
{% endif_version -%}
{% if_version gte:1.40.x -%}
* [deck file kong2tf](/deck/{{page.release}}/reference/deck_file_kong2tf) - Convert decK state files to Terraform resources.
{% endif_version -%}
{% if_version gte:1.28.x -%}
* [deck file lint](/deck/{{page.release}}/reference/deck_file_lint) - Validate a file against a ruleset
{% endif_version -%}
Expand Down
3 changes: 3 additions & 0 deletions app/_src/deck/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,9 @@ The decK commands are structured into three main categories:
- [deck file render](/deck/{{page.release}}/reference/deck_file_render/): Fuses multiple complete decK files, rendering a singular, unified configuration.
- [deck file validate](/deck/{{page.release}}/reference/deck_file_validate/): Conducts an offline validation of the state file, pinpointing potential issues.
- [deck file kong2kic](/deck/{{page.release}}/reference/deck_file_kong2kic/): Converts decK state files into {{site.kic_product_name}} manifests.
{%- if_version gte:1.40.x %}
- [deck file kong2tf](/deck/{{page.release}}/reference/deck_file_kong2tf/): Converts decK state files into Terraform resources.
{% endif_version %}

3. **Gateway State Management**: This category encompasses commands that facilitate
the synchronization of the final decK file with the target platform, be it {{site.konnect_product_name}}, {{site.base_gateway}},
Expand Down
Loading

0 comments on commit 1cca572

Please sign in to comment.