ves-io-schema-tunnel-API-Create

Examples of creating tunnel

Usecase:

Create tunnel-1

Request using vesctl:

vesctl configuration create tunnel -i tunnel.yaml

where file tunnel.yaml has following contents (tunnel.CreateRequest):

RequestJSON:

{
    "metadata": {
        "name": "tunnel-1",
        "namespace": "system"
    },
    "spec": {
        "local_ip": {
            "intf": {
                "local_intf": [
                    {
                        "tenant": "acmecorp",
                        "namespace": "system",
                        "name": "network-interface-1"
                    }
                ]
            }
        },
        "remote_ip": {
            "endpoints": {
                "endpoints": {
                    "master-0/node-1": {
                        "ip": {
                            "ipv4": {
                                "addr": "1.1.1.1"
                            }
                        }
                    },
                    "node-2": {
                        "ip": {
                            "ipv4": {
                                "addr": "1.1.1.2"
                            }
                        }
                    }
                }
            }
        },
        "params": {
            "ipsec": {
                "ipsec_psk": {
                    "clear_secret_info": {
                        "url": "string://\u003cbase64\u003e"
                    }
                }
            }
        }
    }
}

vesctl yaml response:

ResponseJSON:

{
    "metadata": {
        "name": "tunnel-1",
        "namespace": "system",
        "labels": {},
        "annotations": {},
        "description": "",
        "disable": false
    },
    "system_metadata": {
        "uid": "49620954-e94d-4941-ac21-f76b0b3d8ad6",
        "creation_timestamp": "2022-09-23T13:15:56.804024705Z",
        "deletion_timestamp": null,
        "modification_timestamp": null,
        "initializers": null,
        "finalizers": [],
        "tenant": "acmecorp",
        "creator_class": "examplesvc",
        "creator_id": "examplesvc",
        "object_index": 0,
        "owner_view": null,
        "labels": {}
    },
    "spec": {
        "tunnel_type": "IPSEC_PSK",
        "local_ip": {
            "intf": {
                "local_intf": [
                    {
                        "kind": "network_interface.Object",
                        "uid": "ffffffff-ffff-ffff-ffff-ffffffffffff",
                        "tenant": "acmecorp",
                        "namespace": "system",
                        "name": "network-interface-1"
                    }
                ]
            }
        },
        "remote_ip": {
            "endpoints": {
                "endpoints": {
                    "master-0/node-1": {
                        "ip": {
                            "ipv4": {
                                "addr": "1.1.1.1"
                            }
                        }
                    },
                    "node-2": {
                        "ip": {
                            "ipv4": {
                                "addr": "1.1.1.2"
                            }
                        }
                    }
                }
            }
        },
        "params": {
            "ipsec": {
                "ipsec_psk": {
                    "clear_secret_info": {
                        "provider": "",
                        "url": "string://\u003cbase64\u003e"
                    },
                    "blindfold_secret_info_internal": null,
                    "secret_encoding_type": "EncodingNone"
                }
            }
        }
    }
}

Request using curl:

curl -X 'POST' -d '{"metadata":{"name":"tunnel-1","namespace":"system"},"spec":{"local_ip":{"intf":{"local_intf":[{"tenant":"acmecorp","namespace":"system","name":"network-interface-1"}]}},"remote_ip":{"endpoints":{"endpoints":{"master-0/node-1":{"ip":{"ipv4":{"addr":"1.1.1.1"}}},"node-2":{"ip":{"ipv4":{"addr":"1.1.1.2"}}}}}},"params":{"ipsec":{"ipsec_psk":{"clear_secret_info":{"url":"string://\u003cbase64\u003e"}}}}}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_tmp_go-build243329498_b001_apidocs.test/host=docker-desktop' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/system/tunnels'

curl response:

HTTP/1.1 200 OK
Content-Type: application/json
Date: Fri, 23 Sep 2022 13:15:56 GMT
Vary: Accept-Encoding

{
  "metadata": {
    "name": "tunnel-1",
    "namespace": "system",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "49620954-e94d-4941-ac21-f76b0b3d8ad6",
    "creation_timestamp": "2022-09-23T13:15:56.804024705Z",
    "deletion_timestamp": null,
    "modification_timestamp": null,
    "initializers": null,
    "finalizers": [
    ],
    "tenant": "acmecorp",
    "creator_class": "examplesvc",
    "creator_id": "examplesvc",
    "object_index": 0,
    "owner_view": null,
    "labels": {
    }
  },
  "spec": {
    "tunnel_type": "IPSEC_PSK",
    "local_ip": {
      "intf": {
        "local_intf": [
          {
            "kind": "network_interface.Object",
            "uid": "ffffffff-ffff-ffff-ffff-ffffffffffff",
            "tenant": "acmecorp",
            "namespace": "system",
            "name": "network-interface-1"
          }
        ]
      }
    },
    "remote_ip": {
      "endpoints": {
        "endpoints": {
          "master-0/node-1": {
            "ip": {
              "ipv4": {
                "addr": "1.1.1.1"
              }
            }
          },
          "node-2": {
            "ip": {
              "ipv4": {
                "addr": "1.1.1.2"
              }
            }
          }
        }
      }
    },
    "params": {
      "ipsec": {
        "ipsec_psk": {
          "clear_secret_info": {
            "provider": "",
            "url": "string://\u003cbase64\u003e"
          },
          "blindfold_secret_info_internal": null,
          "secret_encoding_type": "EncodingNone"
        }
      }
    }
  }
}

Usecase:

Create tunnel-2

Request using vesctl:

vesctl configuration create tunnel -i tunnel.yaml

where file tunnel.yaml has following contents (tunnel.CreateRequest):

RequestJSON:

{
    "metadata": {
        "name": "tunnel-2",
        "namespace": "system"
    },
    "spec": {
        "local_ip": {
            "ip_address": {
                "ip_address": {
                    "ipv4": {
                        "addr": "192.168.0.10"
                    }
                },
                "virtual_network_type": {
                    "site_local": {}
                }
            }
        },
        "remote_ip": {
            "ip": {
                "ipv4": {
                    "addr": "192.168.0.10"
                }
            }
        },
        "params": {
            "ipsec": {
                "ipsec_psk": {
                    "clear_secret_info": {
                        "url": "string://\u003cbase64\u003e"
                    }
                }
            }
        }
    }
}

vesctl yaml response:

ResponseJSON:

{
    "metadata": {
        "name": "tunnel-2",
        "namespace": "system",
        "labels": {},
        "annotations": {},
        "description": "",
        "disable": false
    },
    "system_metadata": {
        "uid": "1fb69b1a-f60b-4f35-948a-c625b0a32c0e",
        "creation_timestamp": "2022-09-23T13:15:56.811960727Z",
        "deletion_timestamp": null,
        "modification_timestamp": null,
        "initializers": null,
        "finalizers": [],
        "tenant": "acmecorp",
        "creator_class": "examplesvc",
        "creator_id": "examplesvc",
        "object_index": 0,
        "owner_view": null,
        "labels": {}
    },
    "spec": {
        "tunnel_type": "IPSEC_PSK",
        "local_ip": {
            "ip_address": {
                "ip_address": {
                    "ipv4": {
                        "addr": "192.168.0.10"
                    }
                },
                "virtual_network_type": {
                    "site_local": {}
                }
            }
        },
        "remote_ip": {
            "ip": {
                "ipv4": {
                    "addr": "192.168.0.10"
                }
            }
        },
        "params": {
            "ipsec": {
                "ipsec_psk": {
                    "clear_secret_info": {
                        "provider": "",
                        "url": "string://\u003cbase64\u003e"
                    },
                    "blindfold_secret_info_internal": null,
                    "secret_encoding_type": "EncodingNone"
                }
            }
        }
    }
}

Request using curl:

curl -X 'POST' -d '{"metadata":{"name":"tunnel-2","namespace":"system"},"spec":{"local_ip":{"ip_address":{"ip_address":{"ipv4":{"addr":"192.168.0.10"}},"virtual_network_type":{"site_local":{}}}},"remote_ip":{"ip":{"ipv4":{"addr":"192.168.0.10"}}},"params":{"ipsec":{"ipsec_psk":{"clear_secret_info":{"url":"string://\u003cbase64\u003e"}}}}}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_tmp_go-build243329498_b001_apidocs.test/host=docker-desktop' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/system/tunnels'

curl response:

HTTP/1.1 200 OK
Content-Length: 1291
Content-Type: application/json
Date: Fri, 23 Sep 2022 13:15:56 GMT
Vary: Accept-Encoding

{
  "metadata": {
    "name": "tunnel-2",
    "namespace": "system",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "1fb69b1a-f60b-4f35-948a-c625b0a32c0e",
    "creation_timestamp": "2022-09-23T13:15:56.811960727Z",
    "deletion_timestamp": null,
    "modification_timestamp": null,
    "initializers": null,
    "finalizers": [
    ],
    "tenant": "acmecorp",
    "creator_class": "examplesvc",
    "creator_id": "examplesvc",
    "object_index": 0,
    "owner_view": null,
    "labels": {
    }
  },
  "spec": {
    "tunnel_type": "IPSEC_PSK",
    "local_ip": {
      "ip_address": {
        "ip_address": {
          "ipv4": {
            "addr": "192.168.0.10"
          }
        },
        "virtual_network_type": {
          "site_local": {

          }
        }
      }
    },
    "remote_ip": {
      "ip": {
        "ipv4": {
          "addr": "192.168.0.10"
        }
      }
    },
    "params": {
      "ipsec": {
        "ipsec_psk": {
          "clear_secret_info": {
            "provider": "",
            "url": "string://\u003cbase64\u003e"
          },
          "blindfold_secret_info_internal": null,
          "secret_encoding_type": "EncodingNone"
        }
      }
    }
  }
}

Usecase:

Create tunnel-3

Request using vesctl:

vesctl configuration create tunnel -i tunnel.yaml

where file tunnel.yaml has following contents (tunnel.CreateRequest):

RequestJSON:

{
    "metadata": {
        "name": "tunnel-3",
        "namespace": "system"
    },
    "spec": {
        "local_ip": {
            "ip_address": {
                "ip_address": {
                    "ipv4": {
                        "addr": "192.168.0.10"
                    }
                },
                "virtual_network_type": {
                    "site_local_inside": {}
                }
            }
        },
        "remote_ip": {
            "ip": {
                "ipv4": {
                    "addr": "192.168.0.10"
                }
            }
        },
        "params": {
            "ipsec": {
                "ipsec_psk": {
                    "clear_secret_info": {
                        "url": "string://\u003cbase64\u003e"
                    }
                }
            }
        }
    }
}

vesctl yaml response:

ResponseJSON:

{
    "metadata": {
        "name": "tunnel-3",
        "namespace": "system",
        "labels": {},
        "annotations": {},
        "description": "",
        "disable": false
    },
    "system_metadata": {
        "uid": "1f48ba40-86f5-44a8-823d-2eb8c069703d",
        "creation_timestamp": "2022-09-23T13:15:56.816029854Z",
        "deletion_timestamp": null,
        "modification_timestamp": null,
        "initializers": null,
        "finalizers": [],
        "tenant": "acmecorp",
        "creator_class": "examplesvc",
        "creator_id": "examplesvc",
        "object_index": 0,
        "owner_view": null,
        "labels": {}
    },
    "spec": {
        "tunnel_type": "IPSEC_PSK",
        "local_ip": {
            "ip_address": {
                "ip_address": {
                    "ipv4": {
                        "addr": "192.168.0.10"
                    }
                },
                "virtual_network_type": {
                    "site_local_inside": {}
                }
            }
        },
        "remote_ip": {
            "ip": {
                "ipv4": {
                    "addr": "192.168.0.10"
                }
            }
        },
        "params": {
            "ipsec": {
                "ipsec_psk": {
                    "clear_secret_info": {
                        "provider": "",
                        "url": "string://\u003cbase64\u003e"
                    },
                    "blindfold_secret_info_internal": null,
                    "secret_encoding_type": "EncodingNone"
                }
            }
        }
    }
}

Request using curl:

curl -X 'POST' -d '{"metadata":{"name":"tunnel-3","namespace":"system"},"spec":{"local_ip":{"ip_address":{"ip_address":{"ipv4":{"addr":"192.168.0.10"}},"virtual_network_type":{"site_local_inside":{}}}},"remote_ip":{"ip":{"ipv4":{"addr":"192.168.0.10"}}},"params":{"ipsec":{"ipsec_psk":{"clear_secret_info":{"url":"string://\u003cbase64\u003e"}}}}}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_tmp_go-build243329498_b001_apidocs.test/host=docker-desktop' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/system/tunnels'

curl response:

HTTP/1.1 200 OK
Content-Length: 1298
Content-Type: application/json
Date: Fri, 23 Sep 2022 13:15:56 GMT
Vary: Accept-Encoding

{
  "metadata": {
    "name": "tunnel-3",
    "namespace": "system",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "1f48ba40-86f5-44a8-823d-2eb8c069703d",
    "creation_timestamp": "2022-09-23T13:15:56.816029854Z",
    "deletion_timestamp": null,
    "modification_timestamp": null,
    "initializers": null,
    "finalizers": [
    ],
    "tenant": "acmecorp",
    "creator_class": "examplesvc",
    "creator_id": "examplesvc",
    "object_index": 0,
    "owner_view": null,
    "labels": {
    }
  },
  "spec": {
    "tunnel_type": "IPSEC_PSK",
    "local_ip": {
      "ip_address": {
        "ip_address": {
          "ipv4": {
            "addr": "192.168.0.10"
          }
        },
        "virtual_network_type": {
          "site_local_inside": {

          }
        }
      }
    },
    "remote_ip": {
      "ip": {
        "ipv4": {
          "addr": "192.168.0.10"
        }
      }
    },
    "params": {
      "ipsec": {
        "ipsec_psk": {
          "clear_secret_info": {
            "provider": "",
            "url": "string://\u003cbase64\u003e"
          },
          "blindfold_secret_info_internal": null,
          "secret_encoding_type": "EncodingNone"
        }
      }
    }
  }
}

Usecase:

Create tunnel-4

Request using vesctl:

vesctl configuration create tunnel -i tunnel.yaml

where file tunnel.yaml has following contents (tunnel.CreateRequest):

RequestJSON:

{
    "metadata": {
        "name": "tunnel-4",
        "namespace": "system"
    },
    "spec": {
        "local_ip": {
            "ip_address": {
                "ip_address": {
                    "ipv4": {
                        "addr": "192.168.0.10"
                    }
                },
                "virtual_network_type": {
                    "public": {}
                }
            }
        },
        "remote_ip": {
            "ip": {
                "ipv4": {
                    "addr": "192.168.0.10"
                }
            }
        },
        "params": {
            "ipsec": {
                "ipsec_psk": {
                    "clear_secret_info": {
                        "url": "string://\u003cbase64\u003e"
                    }
                }
            }
        }
    }
}

vesctl yaml response:

ResponseJSON:

{
    "metadata": {
        "name": "tunnel-4",
        "namespace": "system",
        "labels": {},
        "annotations": {},
        "description": "",
        "disable": false
    },
    "system_metadata": {
        "uid": "482375b6-c085-449c-b021-16be3e826a7e",
        "creation_timestamp": "2022-09-23T13:15:56.820479910Z",
        "deletion_timestamp": null,
        "modification_timestamp": null,
        "initializers": null,
        "finalizers": [],
        "tenant": "acmecorp",
        "creator_class": "examplesvc",
        "creator_id": "examplesvc",
        "object_index": 0,
        "owner_view": null,
        "labels": {}
    },
    "spec": {
        "tunnel_type": "IPSEC_PSK",
        "local_ip": {
            "ip_address": {
                "ip_address": {
                    "ipv4": {
                        "addr": "192.168.0.10"
                    }
                },
                "virtual_network_type": {
                    "public": {}
                }
            }
        },
        "remote_ip": {
            "ip": {
                "ipv4": {
                    "addr": "192.168.0.10"
                }
            }
        },
        "params": {
            "ipsec": {
                "ipsec_psk": {
                    "clear_secret_info": {
                        "provider": "",
                        "url": "string://\u003cbase64\u003e"
                    },
                    "blindfold_secret_info_internal": null,
                    "secret_encoding_type": "EncodingNone"
                }
            }
        }
    }
}

Request using curl:

curl -X 'POST' -d '{"metadata":{"name":"tunnel-4","namespace":"system"},"spec":{"local_ip":{"ip_address":{"ip_address":{"ipv4":{"addr":"192.168.0.10"}},"virtual_network_type":{"public":{}}}},"remote_ip":{"ip":{"ipv4":{"addr":"192.168.0.10"}}},"params":{"ipsec":{"ipsec_psk":{"clear_secret_info":{"url":"string://\u003cbase64\u003e"}}}}}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_tmp_go-build243329498_b001_apidocs.test/host=docker-desktop' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/system/tunnels'

curl response:

HTTP/1.1 200 OK
Content-Length: 1287
Content-Type: application/json
Date: Fri, 23 Sep 2022 13:15:56 GMT
Vary: Accept-Encoding

{
  "metadata": {
    "name": "tunnel-4",
    "namespace": "system",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "482375b6-c085-449c-b021-16be3e826a7e",
    "creation_timestamp": "2022-09-23T13:15:56.820479910Z",
    "deletion_timestamp": null,
    "modification_timestamp": null,
    "initializers": null,
    "finalizers": [
    ],
    "tenant": "acmecorp",
    "creator_class": "examplesvc",
    "creator_id": "examplesvc",
    "object_index": 0,
    "owner_view": null,
    "labels": {
    }
  },
  "spec": {
    "tunnel_type": "IPSEC_PSK",
    "local_ip": {
      "ip_address": {
        "ip_address": {
          "ipv4": {
            "addr": "192.168.0.10"
          }
        },
        "virtual_network_type": {
          "public": {

          }
        }
      }
    },
    "remote_ip": {
      "ip": {
        "ipv4": {
          "addr": "192.168.0.10"
        }
      }
    },
    "params": {
      "ipsec": {
        "ipsec_psk": {
          "clear_secret_info": {
            "provider": "",
            "url": "string://\u003cbase64\u003e"
          },
          "blindfold_secret_info_internal": null,
          "secret_encoding_type": "EncodingNone"
        }
      }
    }
  }
}

Usecase:

Create tunnel-5

Request using vesctl:

vesctl configuration create tunnel -i tunnel.yaml

where file tunnel.yaml has following contents (tunnel.CreateRequest):

RequestJSON:

{
    "metadata": {
        "name": "tunnel-5",
        "namespace": "system"
    },
    "spec": {
        "local_ip": {
            "ip_address": {
                "auto": {},
                "virtual_network_type": {
                    "site_local": {}
                }
            }
        },
        "remote_ip": {
            "ip": {
                "ipv4": {
                    "addr": "192.168.0.10"
                }
            }
        },
        "params": {
            "ipsec": {
                "ipsec_psk": {
                    "clear_secret_info": {
                        "url": "string://\u003cbase64\u003e"
                    }
                }
            }
        }
    }
}

vesctl yaml response:

ResponseJSON:

{
    "metadata": {
        "name": "tunnel-5",
        "namespace": "system",
        "labels": {},
        "annotations": {},
        "description": "",
        "disable": false
    },
    "system_metadata": {
        "uid": "20fa6583-04ea-46a7-a015-6b3433471d67",
        "creation_timestamp": "2022-09-23T13:15:56.825578900Z",
        "deletion_timestamp": null,
        "modification_timestamp": null,
        "initializers": null,
        "finalizers": [],
        "tenant": "acmecorp",
        "creator_class": "examplesvc",
        "creator_id": "examplesvc",
        "object_index": 0,
        "owner_view": null,
        "labels": {}
    },
    "spec": {
        "tunnel_type": "IPSEC_PSK",
        "local_ip": {
            "ip_address": {
                "auto": {},
                "virtual_network_type": {
                    "site_local": {}
                }
            }
        },
        "remote_ip": {
            "ip": {
                "ipv4": {
                    "addr": "192.168.0.10"
                }
            }
        },
        "params": {
            "ipsec": {
                "ipsec_psk": {
                    "clear_secret_info": {
                        "provider": "",
                        "url": "string://\u003cbase64\u003e"
                    },
                    "blindfold_secret_info_internal": null,
                    "secret_encoding_type": "EncodingNone"
                }
            }
        }
    }
}

Request using curl:

curl -X 'POST' -d '{"metadata":{"name":"tunnel-5","namespace":"system"},"spec":{"local_ip":{"ip_address":{"auto":{},"virtual_network_type":{"site_local":{}}}},"remote_ip":{"ip":{"ipv4":{"addr":"192.168.0.10"}}},"params":{"ipsec":{"ipsec_psk":{"clear_secret_info":{"url":"string://\u003cbase64\u003e"}}}}}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_tmp_go-build243329498_b001_apidocs.test/host=docker-desktop' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/system/tunnels'

curl response:

HTTP/1.1 200 OK
Content-Length: 1219
Content-Type: application/json
Date: Fri, 23 Sep 2022 13:15:56 GMT
Vary: Accept-Encoding

{
  "metadata": {
    "name": "tunnel-5",
    "namespace": "system",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "20fa6583-04ea-46a7-a015-6b3433471d67",
    "creation_timestamp": "2022-09-23T13:15:56.825578900Z",
    "deletion_timestamp": null,
    "modification_timestamp": null,
    "initializers": null,
    "finalizers": [
    ],
    "tenant": "acmecorp",
    "creator_class": "examplesvc",
    "creator_id": "examplesvc",
    "object_index": 0,
    "owner_view": null,
    "labels": {
    }
  },
  "spec": {
    "tunnel_type": "IPSEC_PSK",
    "local_ip": {
      "ip_address": {
        "auto": {

        },
        "virtual_network_type": {
          "site_local": {

          }
        }
      }
    },
    "remote_ip": {
      "ip": {
        "ipv4": {
          "addr": "192.168.0.10"
        }
      }
    },
    "params": {
      "ipsec": {
        "ipsec_psk": {
          "clear_secret_info": {
            "provider": "",
            "url": "string://\u003cbase64\u003e"
          },
          "blindfold_secret_info_internal": null,
          "secret_encoding_type": "EncodingNone"
        }
      }
    }
  }
}