introduce service based view description

This commit is contained in:
Tino Schreiber 2024-09-26 08:20:50 +00:00
parent ecd76023b9
commit e2e47c51fc
5 changed files with 93 additions and 9 deletions

View File

@ -37,11 +37,11 @@ Once you have obtained this head over to GitHub and follow the instructions to i
Configuring your backend
------------------------
Your backend needs to check the validity of the captcha token which the user generated.
Your backend needs to check the validity of the captcha token which the user generated.
You can do this easily by sending an request using the generated token from the client, your sitekey and your secret key to mCaptcha.
.. code:: Javascript
const postData = {
token: captcha_token,
key: captcha_sitekey,

View File

@ -24,7 +24,7 @@ How it works
Compared to classic Captcha Solutions like Google's Recaptcha this service does not have any image challenges, audio challenges or any Cookie tracking.
Instead it is using a proof-of-work solution. Each user will get a small puzzle which the browser needs to solve. This works by using WebAssembly to compute the solution using the CPU of the device from the client.
Typically this will not take longer than around one second, although this time can be modified in the settings of mCaptcha for each unique site. In case there will be lots of traffic the puzzle will get more complex and the time for solving it will increase.
This effectively makes attacks from outside very hard to impossible as they would need a lot of compute power to break the Captcha.
This effectively makes attacks from outside very hard to impossible as they would need a lot of compute power to break the Captcha.
ReCaptcha works in the same way, if you solve a lot of Captchas they will get harder and harder, just that you need to click on more and more pictures there instead of solving mathematical puzzles with compute power.
For more information on how to configure mCaptcha head over to `Configuration of a new Site <configuration_of_a_new_site>`
For more information on how to configure mCaptcha head over to `Configuration of a new Site <configuration_of_a_new_site>`

View File

@ -6,3 +6,4 @@ Helpcenter Operations
:maxdepth: 2
backstage_add_repo
service_based_view

View File

@ -0,0 +1,83 @@
============================
Service Based View knowledge
============================
This document describe necessary knowledge about our Service Based View (SVB)
which is the landing page for the specific service. There you have a short
description of the service and you get all the links for the service
documents.
Service Based View Code Snippets
--------------------------------
The following Code Snippets represents the necessary information which is
needed that SVB can run properly.
Internal SVB Code Snippet
^^^^^^^^^^^^^^^^^^^^^^^^^
.. code::
Cloud Container Engine
======================
CCE provides highly scalable, high-performance, enterprise-class Kubernetes clusters. It supports native Kubernetes applications, tools and easy setup of container runtime environment.
.. directive_wrapper::
:class: container-sbv
.. service_card::
:service_type: cce
:environment: internal
:umn: Describes the basic concepts, functions, key terms, best practices, FAQs and steps for quickly creating clusters and containerized applications.
:api-ref: Describes the APIs provided by CCE including the functions, parameters, and examples of each API.
:best-practice: To use Cloud Container Engine more securely, reliably, flexibly, and efficiently, you are advised to follow the following best practices.
Documents registration under: `otc_metadata/data/documents <https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata/src/branch/main/otc_metadata/data/documents>`_
Public SVB Code Snippet
^^^^^^^^^^^^^^^^^^^^^^^
.. code::
Cloud Container Engine
======================
CCE provides highly scalable, high-performance, enterprise-class Kubernetes clusters. It supports native Kubernetes applications, tools and easy setup of container runtime environment.
.. directive_wrapper::
:class: container-sbv
.. service_card::
:service_type: cce
:umn: Describes the basic concepts, functions, key terms, best practices, FAQs and steps for quickly creating clusters and containerized applications.
:api-ref: Describes the APIs provided by CCE including the functions, parameters, and examples of each API.
:best-practice: To use Cloud Container Engine more securely, reliably, flexibly, and efficiently, you are advised to follow the following best practices.
Documents registration under: `otc_metadata/data/documents <https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata/src/branch/main/otc_metadata/data/documents>`_
Possible Document Names
^^^^^^^^^^^^^^^^^^^^^^^
* api-ref
* blueprints
* caf
* dev
* image-creation-guide
* tool-guide
* mycredential
* public-images
* sdk-ref
* operation-guide
* operation-guide-lts
* parallel-file-system
* permissions-configuration-guide
* permissions
* swiftapi
* s3api
* umn
* umn2
* best-practice
* sqlreference
* guidelines

View File

@ -28,11 +28,11 @@ Sync work with main currently do not support sync in console and you need to do
.. code-block:: text
Host gitea.eco.tsi-dev.otc-service.com
User git
Port 2222
HostName gitea.eco.tsi-dev.otc-service.com
IdentityFile ~/.ssh/id_rsa
Host gitea.eco.tsi-dev.otc-service.com
User git
Port 2222
HostName gitea.eco.tsi-dev.otc-service.com
IdentityFile ~/.ssh/id_rsa
You should be able to ssh gitea and get You've successfully authenticated message.