Resource

In Nanocl, a Resource refers to a configuration setting.
A Resource can be any Kind of configuration defined by the user, currently there is only no Kind of Resource natively supported:

While Kind of Resource can be defined by the user, there is currently two type of Resources usually supported after a basic installation:

Plugin Kind	Usage
ncproxy.io/rule	data for setup a proxy config installed by our proxy controller
ncdns.io/rule	data for setup a dns config installed by our dns controller

Proxy Rule

As the name suggests, a ProxyRule is a configuration that determines how your cargoes can be accessed through the proxy.
By configuring ProxyRules, you can fine-tune the accessibility of your cargoes.

There is the openapi specification to create a proxy ProxyRule:

required

Array of ProxyRuleHttp (object) or ProxyRuleStream (object) (ProxyRule) The rules to apply

{

• "Rules": [

  • {

    • "Domain": "string",
    • "Port": 0,
    • "Network": "All",
    • "LimitReqZone": { },
    • "Locations": [

      • {

        • "Path": "string",
        • "Target": {

          • "Key": "string",
          • "Port": 0,
          • "Path": "string",
          • "DisableLogging": true,
          • "Ssl": { }

          },
        • "LimitReq": { },
        • "AllowedIps": [

          • "string"

          ],
        • "Headers": [

          • "string"

          ],
        • "Version": 0

        }

      ],
    • "Ssl": { },
    • "Includes": [

      • "string"

      ]

    }

  ]

}

Proxy Rule Network

Network	Usage
All	Bind on all network addresses
Local	Bind only on 127.0.0.1
Public	Bind only on public ip address
Internal	Bind on internal nanocl gateway

Dns Rule

As the name suggests, a DnsRule is a configuration that determines how a dns server is configured.
That way you can tunes your network access with domain names.

There is the openapi specification to create a proxy ProxyRule:

required	Array of objects (DnsEntry)
required	string or string or string or string or object (NetworkKind)

{

• "Network": "All",
• "Entries": [

  • {

    • "Name": "string",
    • "IpAddress": "All"

    }

  ]

}