package
2.0.3+incompatible
Repository: https://github.com/3scale/istio-integration.git
Documentation: pkg.go.dev

# README

CustomResource Generator

This program produces sample CustomResource definitions for handler, instance and rule CustomResources.

The manifests produced are tested against the integration test suite in the gRPC adapter code.

Usage

The program accepts a number of flags which are documented in the table below:

OptionDescriptionRequiredDefault
-h, --helpProduces help output for available optionsNo
--nameUnique name for this (url,token) pairYes
-n,--namespaceNamespace to generate templates forNoistio-system
-t,--token3scale access tokenYes
-u,--url3scale Admin Portal URLYes
--backend-url3scale Backend URL. If set, overrides the value read from system configurationNo
--service3scale Service ID. If set, generated config will apply to this service onlyNo
--auth3scale authentication pattern to specify (1=Api Key, 2=App Id/App Key, 3=OIDC)NoHybrid
-o,--outputFile to save produced manifests toNoSTDOUT
--versionOutputs the CLI version (and exits right away)No

Example

This example will generate generic templates, allowing the token,url pair to be shared by multiple services as a single handler

3scale-config-gen --name=admin-credentials --url="https://myorg-admin.3scale.net:443" --token="[redacted]"

This example will generate the templates with the service ID embedded in the handler:

3scale-config-gen --url="https://myorg-admin.3scale.net" --name="my-unique-id" --service="123456789" --token="[redacted]"