Skip to content

Commit

Permalink
Merge branch 'master' into update-no-actions
Browse files Browse the repository at this point in the history
  • Loading branch information
@thomasht86
thomasht86 authored Aug 20, 2024
2 parents 7c97d70 + df07289 commit 5e6494a
Showing 1 changed file with 110 additions and 19 deletions.
129 changes: 110 additions & 19 deletions docs/sphinx/source/authenticating-to-vespa-cloud.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,25 +110,116 @@
"\n",
"## Control-plane vs Data-plane\n",
"\n",
"This may be self-explanatory for some, but it is worth mentioning that Vespa Cloud has two main components: the control-plane and the data-plane, which provide access to different functionalities.\n",
"\n",
"| | Control-plane | Data-plane | Comments |\n",
"| ------------------------------------------------------------------------------------------ | ------------- | ---------- | ------------------------------------------------------------------------------------------ |\n",
"| Deploy application | ✅ | ❌ | |\n",
"| Modify application (re-deploy) | ✅ | ❌ | |\n",
"| Add or modify data-plane certs or token(s) | ✅ | ❌ | |\n",
"| Feed data | ❌ | ✅ | |\n",
"| Query data | ❌ | ✅ | |\n",
"| Delete data | ❌ | ✅ | |\n",
"| [Visiting](https://docs.vespa.ai/en/visiting.html) | ❌ | ✅ | |\n",
"| [Monitoring](https://cloud.vespa.ai/en/monitoring) | ❌ | ✅ | |\n",
"| Get application package | ✅ | ❌ | |\n",
"| [vespa auth login](https://docs.vespa.ai/en/reference/vespa-cli/vespa_auth_login.html) | ✅ | ❌ | Interactive control-plane login in browser |\n",
"| [vespa auth api-key](https://docs.vespa.ai/en/reference/vespa-cli/vespa_auth_api-key.html) | ✅ | ❌ | Headless control-plane authentication with an API key generated in the Vespa Cloud console |\n",
"| [vespa auth cert](https://docs.vespa.ai/en/reference/vespa-cli/vespa_auth_cert.html) | ❌ | ✅ | Used to generate a certificate for a data-plane connection |\n",
"| [VespaCloud](https://pyvespa.readthedocs.io/en/latest/reference-api.html#vespacloud) | ✅ | ❌ | `VespaCloud` is a control-plane connection to Vespa Cloud |\n",
"| [VespaDocker](https://pyvespa.readthedocs.io/en/latest/reference-api.html#vespadocker) | ✅ | ❌ | `VespaDocker` is a control-plane connection to a Vespa server running in Docker |\n",
"| [Vespa](https://pyvespa.readthedocs.io/en/latest/reference-api.html#vespa) | ❌ | ✅ | `Vespa` is a data-plane connection to an existing Vespa application |\n"
"This may be self-explanatory for some, but it is worth mentioning that Vespa Cloud has two main components: the control-plane and the data-plane, which provide access to different functionalities.\n"
]
},
{
"cell_type": "markdown",
"id": "eb2438b5",
"metadata": {},
"source": [
"<table border=\"1\" class=\"dataframe\">\n",
" <thead>\n",
" <tr style=\"text-align: right;\">\n",
" <th></th>\n",
" <th>Control-plane</th>\n",
" <th>Data-plane</th>\n",
" <th>Comments</th>\n",
" </tr>\n",
" </thead>\n",
" <tbody>\n",
" <tr>\n",
" <td>Deploy application</td>\n",
" <td>✅</td>\n",
" <td>❌</td>\n",
" <td></td>\n",
" </tr>\n",
" <tr>\n",
" <td>Modify application (re-deploy)</td>\n",
" <td>✅</td>\n",
" <td>❌</td>\n",
" <td></td>\n",
" </tr>\n",
" <tr>\n",
" <td>Add or modify data-plane certs or token(s)</td>\n",
" <td>✅</td>\n",
" <td>❌</td>\n",
" <td></td>\n",
" </tr>\n",
" <tr>\n",
" <td>Feed data</td>\n",
" <td>❌</td>\n",
" <td>✅</td>\n",
" <td></td>\n",
" </tr>\n",
" <tr>\n",
" <td>Query data</td>\n",
" <td>❌</td>\n",
" <td>✅</td>\n",
" <td></td>\n",
" </tr>\n",
" <tr>\n",
" <td>Delete data</td>\n",
" <td>❌</td>\n",
" <td>✅</td>\n",
" <td></td>\n",
" </tr>\n",
" <tr>\n",
" <td><a href=\"https://docs.vespa.ai/en/visiting.html\">Visiting</a></td>\n",
" <td>❌</td>\n",
" <td>✅</td>\n",
" <td></td>\n",
" </tr>\n",
" <tr>\n",
" <td><a href=\"https://cloud.vespa.ai/en/monitoring\">Monitoring</a></td>\n",
" <td>❌</td>\n",
" <td>✅</td>\n",
" <td></td>\n",
" </tr>\n",
" <tr>\n",
" <td>Get application package</td>\n",
" <td>✅</td>\n",
" <td>❌</td>\n",
" <td></td>\n",
" </tr>\n",
" <tr>\n",
" <td><a href=\"https://docs.vespa.ai/en/reference/vespa-cli/vespa_auth_login.html\">vespa auth login</a></td>\n",
" <td>✅</td>\n",
" <td>❌</td>\n",
" <td>Interactive control-plane login in browser</td>\n",
" </tr>\n",
" <tr>\n",
" <td><a href=\"https://docs.vespa.ai/en/reference/vespa-cli/vespa_auth_api-key.html\">vespa auth api-key</a></td>\n",
" <td>✅</td>\n",
" <td>❌</td>\n",
" <td>Headless control-plane authentication with an API key generated in the Vespa Cloud console</td>\n",
" </tr>\n",
" <tr>\n",
" <td><a href=\"https://docs.vespa.ai/en/reference/vespa-cli/vespa_auth_cert.html\">vespa auth cert</a></td>\n",
" <td>❌</td>\n",
" <td>✅</td>\n",
" <td>Used to generate a certificate for a data-plane connection</td>\n",
" </tr>\n",
" <tr>\n",
" <td><a href=\"https://pyvespa.readthedocs.io/en/latest/reference-api.html#vespacloud\">VespaCloud</a></td>\n",
" <td>✅</td>\n",
" <td>❌</td>\n",
" <td>`VespaCloud` is a control-plane connection to Vespa Cloud</td>\n",
" </tr>\n",
" <tr>\n",
" <td><a href=\"https://pyvespa.readthedocs.io/en/latest/reference-api.html#vespadocker\">VespaDocker</a></td>\n",
" <td>✅</td>\n",
" <td>❌</td>\n",
" <td>`VespaDocker` is a control-plane connection to a Vespa server running in Docker</td>\n",
" </tr>\n",
" <tr>\n",
" <td><a href=\"https://pyvespa.readthedocs.io/en/latest/reference-api.html#vespa\">Vespa</a></td>\n",
" <td>❌</td>\n",
" <td>✅</td>\n",
" <td>`Vespa` is a data-plane connection to an existing Vespa application</td>\n",
" </tr>\n",
" </tbody>\n",
"</table>\n"
]
},
{
Expand Down

0 comments on commit 5e6494a

Please sign in to comment.