zone outlet

[Preview]

ockam zone outlet [OPTIONS] --relay <RELAY> --to <SOCKET_ADDRESS>

Options

  • --cluster [CLUSTER] (optional)
    The Cluster that hosts the Zone

  • --zone-name [ZONE_NAME] (optional)
    The name of the Zone

  • --zone-config [ZONE_CONFIG] (optional)
    The path to the Zone configuration file, in yaml or json format. If not set, the ./ockam.yaml file from the current directory will be used

  • --enrollment-ticket [ENROLLMENT TICKET] (optional)
    A path, URL or inlined hex-encoded enrollment ticket to use for the Ockam Identity associated to this node. If ommited one will be created automatically with default attributes

  • --relay <RELAY>
    Relay to register at

  • --background (optional)

  • --use-http-api (optional)
    Force the command to use the HTTP API. By default, the command will use the Orchestrator API

  • --api-endpoint [API_ENDPOINT] (optional)
    The API endpoint of the Ockam AI Platform. Can be set using the AI_API_BASE_URL environment variable. Defaults to http://localhost:30080

  • --from [OUTLET_ADDRESS] (optional)
    Service address of your TCP Outlet, which is part of a route used in other commands. This unique address identifies the TCP Outlet worker on the Node on your local machine. Examples are /service/my-outlet or my-outlet. If not provided, the name of the relay will be used

  • --to <SOCKET_ADDRESS>
    Network address where your application is listening to. Your TCP Outlet will forward raw TCP traffic to this destination

  • --allow [POLICY_EXPRESSION] (optional)
    Policy expression that will be used for access control to the TCP Outlet. If you don't provide it, the policy set for the "tcp-outlet" resource type will be used.

You can check the fallback policy with ockam policy show --resource-type tcp-outlet

Learn More:

Use ockam <SUBCOMMAND> --help for more information about a subcommand (e.g., 'cluster' or 'zone').

Learn more about Command: https://docs.ockam.ai/command/ Learn more about Ockam: https://docs.ockam.ai/

Feedback:

If you have questions, as you explore, join us on the Discord channel https://discord.ockam.io