-[](https://github.com/mosn/layotto/actions/workflows/quickstart-checker.yml)
+[](https://github.com/mosn/layotto/actions/workflows/quickstart-checker.yml)
[](https://github.com/mosn/layotto/actions/workflows/layotto-ci.yml)
[](https://godoc.org/mosn.io/layotto)
@@ -137,15 +137,15 @@ Layotto enriches the Protocol Documentation
+ +Table of Contents
+ +
+
+
+
+
+ -
+
+
+
-
+ cryption.proto
+
-
+
+
+
- + SCryptionService + + +
+
+
+
+
+
+
+
+ cryption.proto
Top +[gRPC Service] CryptionService
+CryptionService is used to encrypt or decrypt data.
+| Method Name | Request Type | Response Type | Description |
| Encrypt | +EncryptRequest | +EncryptResponse | +Encrypt data |
+
| Decrypt | +DecryptRequest | +DecryptResponse | +Decrypt data |
+
DecryptRequest
+DecryptRequest is the request of the `Decrypt` method.
+ + +| Field | Type | Label | Description |
| component_name | +string | ++ | The cryption service name, e.g. 'aliyun.kms' |
+
| cipher_text | +bytes | ++ | Required. The encrypted text |
+
DecryptResponse
+DecryptResponse is the response of the `Decrypt` method.
+ + +| Field | Type | Label | Description |
| plain_text | +bytes | ++ | Raw plaintext. |
+
| key_id | +string | ++ | The id of the key used to decrypt this text. |
+
| key_version_id | +string | ++ | The version of the key |
+
EncryptRequest
+EncryptRequest is the request to encrypt data.
+ + +| Field | Type | Label | Description |
| component_name | +string | ++ | The cryption service name, e.g. 'aliyun.kms' |
+
| plain_text | +bytes | ++ | Required. Raw plaintext. |
+
| key_id | +string | ++ | Required. |
+
EncryptResponse
+EncryptResponse is the response of the `Encrypt` method.
+ + +| Field | Type | Label | Description |
| cipher_text | +bytes | ++ | The encrypted text |
+
| key_id | +string | ++ | The id of the key used to decrypt this text. |
+
| key_version_id | +string | ++ | The version of the key |
+
Protocol Documentation
+ +Table of Contents
+ +
+
+
+
+
+ -
+
+
+
-
+ delay_queue.proto
+
-
+
+
+
- + SDelayQueue + + +
+
+
+
+
+
+
+
+ delay_queue.proto
Top +[gRPC Service] DelayQueue
+DelayQueue is a special kind of message queue, which lets you postpone the delivery of new messages to consumers.
For example, you can invoke this API and tell the message queue "please send this message to the consumers after 5 minutes".
+| Method Name | Request Type | Response Type | Description |
| PublishDelayMessage | +DelayMessageRequest | +DelayMessageResponse | +Publish a delay message |
+
DelayMessageRequest
+DelayMessageRequest is the message to publish
+ + +| Field | Type | Label | Description |
| component_name | +string | ++ | Required. The name of the DelayQueue component |
+
| topic | +string | ++ | Required. The pubsub topic |
+
| data | +bytes | ++ | Required. The data which will be published to topic. |
+
| data_content_type | +string | ++ | The content type for the data (optional). |
+
| delay_in_seconds | +int32 | ++ | The length of time, in seconds, for which the delivery +of this messages is delayed. Default: 0. |
+
| metadata | +DelayMessageRequest.MetadataEntry | +repeated | +The metadata passing to pub components + +metadata property: +- key : the key of the message. |
+
DelayMessageRequest.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
DelayMessageResponse
+DelayMessageResponse is the response
+ + +| Field | Type | Label | Description |
| message_id | +string | ++ | The message identifier |
+
Protocol Documentation
+ +Table of Contents
+ +
+
+
+
+
+ -
+
+
+
-
+ email.proto
+
-
+
+
+
- + SEmailService + + +
+
+
+
+
+
+
+
+ email.proto
Top +[gRPC Service] EmailService
+EmailService is used to send emails.
+| Method Name | Request Type | Response Type | Description |
| SendEmailWithTemplate | +SendEmailWithTemplateRequest | +SendEmailWithTemplateResponse | +Send an email with template |
+
| SendEmail | +SendEmailRequest | +SendEmailResponse | +Send an email with raw content instead of using templates. |
+
Content
+Email content
+ + +| Field | Type | Label | Description |
| text | +string | ++ | Required. |
+
EmailAddress
+Address information
+ + +| Field | Type | Label | Description |
| from | +string | ++ | Required. The Email sender address. |
+
| to | +string | +repeated | +Required. The Email destination addresses. |
+
| cc | +string | +repeated | +Optional. To whom the mail is cc |
+
EmailTemplate
+Email template
+ + +| Field | Type | Label | Description |
| template_id | +string | ++ | Required |
+
| template_params | +EmailTemplate.TemplateParamsEntry | +repeated | +Required |
+
EmailTemplate.TemplateParamsEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
SendEmailRequest
+SendEmailRequest is the message send to email.
+ + +| Field | Type | Label | Description |
| component_name | +string | ++ | The saas service name, like 'aliyun.email'/'aws.ses'/'...' + If your system uses multiple IVR services at the same time, + you can specify which service to use with this field. |
+
| setting_id | +string | ++ | Required. |
+
| subject | +string | ++ | Required. The Email subject. |
+
| content | +Content | ++ | Required. |
+
| address | +EmailAddress | ++ | Required. |
+
SendEmailResponse
+The response of `SendEmail` method
+ + +| Field | Type | Label | Description |
| request_id | +string | ++ | The saas requestId. |
+
SendEmailWithTemplateRequest
+SendEmailWithTemplateRequest is the message send to email.
+ + +| Field | Type | Label | Description |
| component_name | +string | ++ | The saas service name, like 'aliyun.email'/'aws.ses'/'...' + If your system uses multiple IVR services at the same time, + you can specify which service to use with this field. |
+
| template | +EmailTemplate | ++ | Required. |
+
| subject | +string | ++ | Required. The Email subject. |
+
| address | +EmailAddress | ++ | Required. |
+
SendEmailWithTemplateResponse
+Response of `SendEmailWithTemplate` method
+ + +| Field | Type | Label | Description |
| request_id | +string | ++ | The saas requestId. |
+
Protocol Documentation
+ +Table of Contents
+ +
+
+
+
+
+ -
+
+
+
-
+ phone.proto
+
-
+
+
+
- + SPhoneCallService + + +
+
+
+
+
+
+
+
+ phone.proto
Top +[gRPC Service] PhoneCallService
+PhoneCallService API is used to send voice messages.
+| Method Name | Request Type | Response Type | Description |
| SendVoiceWithTemplate | +SendVoiceWithTemplateRequest | +SendVoiceWithTemplateResponse | +Send voice using the specific template |
+
SendVoiceWithTemplateRequest
+The request of SendVoiceWithTemplate method
+ + +| Field | Type | Label | Description |
| component_name | +string | ++ | If your system uses multiple IVR services at the same time, +you can specify which service to use with this field. |
+
| template | +VoiceTemplate | ++ | Required |
+
| to_mobile | +string | +repeated | +Required |
+
| from_mobile | +string | ++ | This field is required by some cloud providers. |
+
SendVoiceWithTemplateResponse
+The response of `SendVoiceWithTemplate` method
+ + +| Field | Type | Label | Description |
| request_id | +string | ++ | Id of this request. |
+
VoiceTemplate
+VoiceTemplate
+ + +| Field | Type | Label | Description |
| template_id | +string | ++ | Required |
+
| template_params | +VoiceTemplate.TemplateParamsEntry | +repeated | +Required |
+
VoiceTemplate.TemplateParamsEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
Protocol Documentation
+ +Table of Contents
+ +
+
+
+
+
+ -
+
+
+
-
+ appcallback.proto
+
-
+
+
+
- + SAppCallback + + +
+
+
+ -
+ lifecycle.proto
+
-
+
+
+
- + SLifecycle + + +
+
+
+ -
+ runtime.proto
+
-
+
+
+
- + SRuntime + + +
+
+
+
+
+
+
+
+ appcallback.proto
Top +[gRPC Service] AppCallback
+AppCallback V1 allows user application to interact with runtime.
User application needs to implement AppCallback service if it needs to
receive message from runtime.
+| Method Name | Request Type | Response Type | Description |
| ListTopicSubscriptions | +.google.protobuf.Empty | +ListTopicSubscriptionsResponse | +Lists all topics subscribed by this app. |
+
| OnTopicEvent | +TopicEventRequest | +TopicEventResponse | +Subscribes events from Pubsub |
+
ListTopicSubscriptionsResponse
+ListTopicSubscriptionsResponse is the message including the list of the subscribing topics.
+ + +| Field | Type | Label | Description |
| subscriptions | +TopicSubscription | +repeated | +The list of topics. |
+
TopicEventRequest
+TopicEventRequest message is compatible with CloudEvent spec v1.0
https://github.com/cloudevents/spec/blob/v1.0/spec.md
+ + +| Field | Type | Label | Description |
| id | +string | ++ | id identifies the event. Producers MUST ensure that source + id +is unique for each distinct event. If a duplicate event is re-sent +(e.g. due to a network error) it MAY have the same id. |
+
| source | +string | ++ | source identifies the context in which an event happened. +Often this will include information such as the type of the +event source, the organization publishing the event or the process +that produced the event. The exact syntax and semantics behind +the data encoded in the URI is defined by the event producer. |
+
| type | +string | ++ | The type of event related to the originating occurrence. |
+
| spec_version | +string | ++ | The version of the CloudEvents specification. |
+
| data_content_type | +string | ++ | The content type of data value. |
+
| data | +bytes | ++ | The content of the event. |
+
| topic | +string | ++ | The pubsub topic which publisher sent to. |
+
| pubsub_name | +string | ++ | The name of the pubsub the publisher sent to. |
+
| metadata | +TopicEventRequest.MetadataEntry | +repeated | +add a map to pass some extra properties. |
+
TopicEventRequest.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
TopicEventResponse
+TopicEventResponse is response from app on published message
+ + +| Field | Type | Label | Description |
| status | +TopicEventResponse.TopicEventResponseStatus | ++ | The list of output bindings. |
+
TopicSubscription
+TopicSubscription represents topic and metadata.
+ + +| Field | Type | Label | Description |
| pubsub_name | +string | ++ | Required. The name of the pubsub containing the topic below to subscribe to. |
+
| topic | +string | ++ | Required. The name of topic which will be subscribed |
+
| metadata | +TopicSubscription.MetadataEntry | +repeated | +The optional properties used for this topic's subscription e.g. session id |
+
TopicSubscription.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
TopicEventResponse.TopicEventResponseStatus
+TopicEventResponseStatus allows apps to have finer control over handling of the message.
+| Name | Number | Description |
| SUCCESS | +0 | +SUCCESS is the default behavior: message is acknowledged and not retried or logged. |
+
| RETRY | +1 | +RETRY status signals runtime to retry the message as part of an expected scenario (no warning is logged). |
+
| DROP | +2 | +DROP status signals runtime to drop the message as part of an unexpected scenario (warning is logged). |
+
+
+
+
+
+ lifecycle.proto
Top +[gRPC Service] Lifecycle
+Lifecycle API is used to manage the sidecar lifecycle.
For example, by invoking the lifecycle API, you can modify the components' configuration during runtime
+| Method Name | Request Type | Response Type | Description |
| ApplyConfiguration | +DynamicConfiguration | +ApplyConfigurationResponse | +Apply the dynamic configuration. +The DynamicConfiguration here should be full configuration, not incremental configuration |
+
ApplyConfigurationResponse
+The response of the `ApplyConfiguration` method.
+ + + + + +ComponentConfig
+The dynamic configuration of a component
+ + +| Field | Type | Label | Description |
| kind | +string | ++ | Required. Which kind of API you are using, e.g. `lock`, `state` |
+
| name | +string | ++ | Required. The component name, e.g. `state_demo` |
+
| metadata | +ComponentConfig.MetadataEntry | +repeated | +Required. The dynamic configuration of this component |
+
ComponentConfig.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
DynamicConfiguration
+The dynamic configuration of the sidecar
+ + +| Field | Type | Label | Description |
| component_config | +ComponentConfig | ++ | Required. The dynamic configuration of a component |
+
+
+
+
+
+ runtime.proto
Top +[gRPC Service] Runtime
+Runtime encapsulates variours Runtime APIs(such as Configuration API, Pub/Sub API, etc)
+| Method Name | Request Type | Response Type | Description |
| SayHello | +SayHelloRequest | +SayHelloResponse | +SayHello used for test |
+
| InvokeService | +InvokeServiceRequest | +InvokeResponse | +InvokeService do rpc calls |
+
| GetConfiguration | +GetConfigurationRequest | +GetConfigurationResponse | +GetConfiguration gets configuration from configuration store. |
+
| SaveConfiguration | +SaveConfigurationRequest | +.google.protobuf.Empty | +SaveConfiguration saves configuration into configuration store. |
+
| DeleteConfiguration | +DeleteConfigurationRequest | +.google.protobuf.Empty | +DeleteConfiguration deletes configuration from configuration store. |
+
| SubscribeConfiguration | +SubscribeConfigurationRequest stream | +SubscribeConfigurationResponse stream | +SubscribeConfiguration gets configuration from configuration store and subscribe the updates. |
+
| TryLock | +TryLockRequest | +TryLockResponse | +Distributed Lock API +A non-blocking method trying to get a lock with ttl. |
+
| Unlock | +UnlockRequest | +UnlockResponse | +A method trying to unlock. |
+
| LockKeepAlive | +LockKeepAliveRequest | +LockKeepAliveResponse | +A method used to support lease renewal for distributed lock. |
+
| GetNextId | +GetNextIdRequest | +GetNextIdResponse | +Sequencer API +Get next unique id with some auto-increment guarantee |
+
| GetState | +GetStateRequest | +GetStateResponse | +Gets the state for a specific key. |
+
| GetBulkState | +GetBulkStateRequest | +GetBulkStateResponse | +Gets a bulk of state items for a list of keys |
+
| SaveState | +SaveStateRequest | +.google.protobuf.Empty | +Saves an array of state objects |
+
| DeleteState | +DeleteStateRequest | +.google.protobuf.Empty | +Deletes the state for a specific key. |
+
| DeleteBulkState | +DeleteBulkStateRequest | +.google.protobuf.Empty | +Deletes a bulk of state items for a list of keys |
+
| ExecuteStateTransaction | +ExecuteStateTransactionRequest | +.google.protobuf.Empty | +Executes transactions for a specified store |
+
| PublishEvent | +PublishEventRequest | +.google.protobuf.Empty | +Publishes events to the specific topic |
+
| GetFile | +GetFileRequest | +GetFileResponse stream | +Get file with stream |
+
| PutFile | +PutFileRequest stream | +.google.protobuf.Empty | +Put file with stream |
+
| ListFile | +ListFileRequest | +ListFileResp | +List all files |
+
| DelFile | +DelFileRequest | +.google.protobuf.Empty | +Delete specific file |
+
| GetFileMeta | +GetFileMetaRequest | +GetFileMetaResponse | +Get file meta data, if file not exist,return code.NotFound error |
+
| InvokeBinding | +InvokeBindingRequest | +InvokeBindingResponse | +Invokes binding data to specific output bindings |
+
| GetSecret | +GetSecretRequest | +GetSecretResponse | +Gets secrets from secret stores. |
+
| GetBulkSecret | +GetBulkSecretRequest | +GetBulkSecretResponse | +Gets a bulk of secrets |
+
BulkStateItem
+BulkStateItem is the response item for a bulk get operation.
Return values include the item key, data and etag.
+ + +| Field | Type | Label | Description |
| key | +string | ++ | state item key |
+
| data | +bytes | ++ | The byte array data |
+
| etag | +string | ++ | The entity tag which represents the specific version of data. +ETag format is defined by the corresponding data store. |
+
| error | +string | ++ | The error that was returned from the state store in case of a failed get operation. |
+
| metadata | +BulkStateItem.MetadataEntry | +repeated | +The metadata which will be sent to app. |
+
BulkStateItem.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
CommonInvokeRequest
+Common invoke request message which includes invoke method and data
+ + +| Field | Type | Label | Description |
| method | +string | ++ | The method of requset |
+
| data | +google.protobuf.Any | ++ | The request data |
+
| content_type | +string | ++ | The content type of request data |
+
| http_extension | +HTTPExtension | ++ | The extra information of http |
+
ConfigurationItem
+ConfigurationItem represents a configuration item with key, content and other information.
+ + +| Field | Type | Label | Description |
| key | +string | ++ | Required. The key of configuration item |
+
| content | +string | ++ | The content of configuration item +Empty if the configuration is not set, including the case that the configuration is changed from value-set to value-not-set. |
+
| group | +string | ++ | The group of configuration item. |
+
| label | +string | ++ | The label of configuration item. |
+
| tags | +ConfigurationItem.TagsEntry | +repeated | +The tag list of configuration item. |
+
| metadata | +ConfigurationItem.MetadataEntry | +repeated | +The metadata which will be passed to configuration store component. |
+
ConfigurationItem.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
ConfigurationItem.TagsEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
DelFileRequest
+Delete file request message
+ + +| Field | Type | Label | Description |
| request | +FileRequest | ++ | File request |
+
DeleteBulkStateRequest
+DeleteBulkStateRequest is the message to delete a list of key-value states from specific state store.
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of state store. |
+
| states | +StateItem | +repeated | +Required. The array of the state key values. |
+
DeleteConfigurationRequest
+DeleteConfigurationRequest is the message to delete a list of key-value configuration from specified configuration store.
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | The name of configuration store. |
+
| app_id | +string | ++ | The application id which +Only used for admin, Ignored and reset for normal client |
+
| group | +string | ++ | The group of keys. |
+
| label | +string | ++ | The label for keys. |
+
| keys | +string | +repeated | +The keys to get. |
+
| metadata | +DeleteConfigurationRequest.MetadataEntry | +repeated | +The metadata which will be sent to configuration store components. |
+
DeleteConfigurationRequest.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
DeleteStateRequest
+DeleteStateRequest is the message to delete key-value states in the specific state store.
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of state store. |
+
| key | +string | ++ | Required. The key of the desired state |
+
| etag | +Etag | ++ | (optional) The entity tag which represents the specific version of data. +The exact ETag format is defined by the corresponding data store. |
+
| options | +StateOptions | ++ | (optional) State operation options which includes concurrency/ +consistency/retry_policy. |
+
| metadata | +DeleteStateRequest.MetadataEntry | +repeated | +(optional) The metadata which will be sent to state store components. |
+
DeleteStateRequest.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
Etag
+Etag represents a state item version
+ + +| Field | Type | Label | Description |
| value | +string | ++ | value sets the etag value |
+
ExecuteStateTransactionRequest
+ExecuteStateTransactionRequest is the message to execute multiple operations on a specified store.
+ + +| Field | Type | Label | Description |
| storeName | +string | ++ | Required. name of state store. |
+
| operations | +TransactionalStateOperation | +repeated | +Required. transactional operation list. |
+
| metadata | +ExecuteStateTransactionRequest.MetadataEntry | +repeated | +(optional) The metadata used for transactional operations. |
+
ExecuteStateTransactionRequest.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
FileInfo
+File info message
+ + +| Field | Type | Label | Description |
| file_name | +string | ++ | The name of file |
+
| size | +int64 | ++ | The size of file |
+
| last_modified | +string | ++ | The modified time of file |
+
| metadata | +FileInfo.MetadataEntry | +repeated | +The metadata for user extension. |
+
FileInfo.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
FileMeta
+A map that store FileMetaValue
+ + +| Field | Type | Label | Description |
| metadata | +FileMeta.MetadataEntry | +repeated | +A data structure to store metadata |
+
FileMeta.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +FileMetaValue | ++ |
|
+
FileMetaValue
+FileMeta value
+ + +| Field | Type | Label | Description |
| value | +string | +repeated | +File meta value |
+
FileRequest
+File request message
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | The name of store |
+
| name | +string | ++ | The name of the directory |
+
| metadata | +FileRequest.MetadataEntry | +repeated | +The metadata for user extension. |
+
FileRequest.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
GetBulkSecretRequest
+GetBulkSecretRequest is the message to get the secrets from secret store.
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | The name of secret store. |
+
| metadata | +GetBulkSecretRequest.MetadataEntry | +repeated | +The metadata which will be sent to secret store components. |
+
GetBulkSecretRequest.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
GetBulkSecretResponse
+GetBulkSecretResponse is the response message to convey the requested secrets.
+ + +| Field | Type | Label | Description |
| data | +GetBulkSecretResponse.DataEntry | +repeated | +data hold the secret values. Some secret store, such as kubernetes secret +store, can save multiple secrets for single secret key. |
+
GetBulkSecretResponse.DataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +SecretResponse | ++ |
|
+
GetBulkStateRequest
+GetBulkStateRequest is the message to get a list of key-value states from specific state store.
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of state store. |
+
| keys | +string | +repeated | +Required. The keys to get. |
+
| parallelism | +int32 | ++ | (optional) The number of parallel operations executed on the state store for a get operation. |
+
| metadata | +GetBulkStateRequest.MetadataEntry | +repeated | +(optional) The metadata which will be sent to state store components. |
+
GetBulkStateRequest.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
GetBulkStateResponse
+GetBulkStateResponse is the response conveying the list of state values.
+ + +| Field | Type | Label | Description |
| items | +BulkStateItem | +repeated | +The list of items containing the keys to get values for. |
+
GetConfigurationRequest
+GetConfigurationRequest is the message to get a list of key-value configuration from specified configuration store.
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | The name of configuration store. |
+
| app_id | +string | ++ | The application id which +Only used for admin, Ignored and reset for normal client |
+
| group | +string | ++ | The group of keys. |
+
| label | +string | ++ | The label for keys. |
+
| keys | +string | +repeated | +The keys to get. |
+
| metadata | +GetConfigurationRequest.MetadataEntry | +repeated | +The metadata which will be sent to configuration store components. |
+
| subscribe_update | +bool | ++ | Subscribes update event for given keys. +If true, when any configuration item in this request is updated, app will receive event by OnConfigurationEvent() of app callback |
+
GetConfigurationRequest.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
GetConfigurationResponse
+GetConfigurationResponse is the response conveying the list of configuration values.
+ + +| Field | Type | Label | Description |
| items | +ConfigurationItem | +repeated | +The list of items containing configuration values. |
+
GetFileMetaRequest
+Get fileMeta request message
+ + +| Field | Type | Label | Description |
| request | +FileRequest | ++ | File meta request |
+
GetFileMetaResponse
+Get fileMeta response message
+ + +| Field | Type | Label | Description |
| size | +int64 | ++ | The size of file |
+
| last_modified | +string | ++ | The modified time of file |
+
| response | +FileMeta | ++ | File meta response |
+
GetFileRequest
+Get file request message
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | The name of store |
+
| name | +string | ++ | The name of the file or object want to get. |
+
| metadata | +GetFileRequest.MetadataEntry | +repeated | +The metadata for user extension. |
+
GetFileRequest.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
GetFileResponse
+Get file response message
+ + +| Field | Type | Label | Description |
| data | +bytes | ++ | The data of file |
+
GetNextIdRequest
+Get next id request message
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. Name of sequencer storage |
+
| key | +string | ++ | Required. key is the identifier of a sequencer namespace,e.g. "order_table". |
+
| options | +SequencerOptions | ++ | (optional) SequencerOptions configures requirements for auto-increment guarantee |
+
| metadata | +GetNextIdRequest.MetadataEntry | +repeated | +(optional) The metadata which will be sent to the component. |
+
GetNextIdRequest.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
GetNextIdResponse
+Get next id response message
+ + +| Field | Type | Label | Description |
| next_id | +int64 | ++ | The next unique id +Fixed int64 overflow problems on JavaScript https://github.com/improbable-eng/ts-protoc-gen#gotchas |
+
GetSecretRequest
+GetSecretRequest is the message to get secret from secret store.
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | The name of secret store. |
+
| key | +string | ++ | The name of secret key. |
+
| metadata | +GetSecretRequest.MetadataEntry | +repeated | +The metadata which will be sent to secret store components. +Contains version, status, and so on... |
+
GetSecretRequest.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
GetSecretResponse
+GetSecretResponse is the response message to convey the requested secret.
+ + +| Field | Type | Label | Description |
| data | +GetSecretResponse.DataEntry | +repeated | +data is the secret value. Some secret store, such as kubernetes secret +store, can save multiple secrets for single secret key. |
+
GetSecretResponse.DataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
GetStateRequest
+GetStateRequest is the message to get key-value states from specific state store.
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of state store. |
+
| key | +string | ++ | Required. The key of the desired state |
+
| consistency | +StateOptions.StateConsistency | ++ | (optional) read consistency mode |
+
| metadata | +GetStateRequest.MetadataEntry | +repeated | +(optional) The metadata which will be sent to state store components. |
+
GetStateRequest.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
GetStateResponse
+GetStateResponse is the response conveying the state value and etag.
+ + +| Field | Type | Label | Description |
| data | +bytes | ++ | The byte array data |
+
| etag | +string | ++ | The entity tag which represents the specific version of data. +ETag format is defined by the corresponding data store. |
+
| metadata | +GetStateResponse.MetadataEntry | +repeated | +The metadata which will be sent to app. |
+
GetStateResponse.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
HTTPExtension
+Http extension message is about invoke http information
+ + +| Field | Type | Label | Description |
| verb | +HTTPExtension.Verb | ++ | The method of http reuest |
+
| querystring | +string | ++ | The query information of http |
+
InvokeBindingRequest
+InvokeBindingRequest is the message to send data to output bindings
+ + +| Field | Type | Label | Description |
| name | +string | ++ | The name of the output binding to invoke. |
+
| data | +bytes | ++ | The data which will be sent to output binding. |
+
| metadata | +InvokeBindingRequest.MetadataEntry | +repeated | +The metadata passing to output binding components +Common metadata property: +- ttlInSeconds : the time to live in seconds for the message. +If set in the binding definition will cause all messages to +have a default time to live. The message ttl overrides any value +in the binding definition. |
+
| operation | +string | ++ | The name of the operation type for the binding to invoke |
+
InvokeBindingRequest.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
InvokeBindingResponse
+InvokeBindingResponse is the message returned from an output binding invocation
+ + +| Field | Type | Label | Description |
| data | +bytes | ++ | The data which will be sent to output binding. |
+
| metadata | +InvokeBindingResponse.MetadataEntry | +repeated | +The metadata returned from an external system |
+
InvokeBindingResponse.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
InvokeResponse
+Invoke service response message is result of invoke service queset
+ + +| Field | Type | Label | Description |
| data | +google.protobuf.Any | ++ | The response data |
+
| content_type | +string | ++ | The content type of response data |
+
InvokeServiceRequest
+Invoke service request message
+ + +| Field | Type | Label | Description |
| id | +string | ++ | The identify of InvokeServiceRequest |
+
| message | +CommonInvokeRequest | ++ | InvokeServiceRequest message |
+
ListFileRequest
+List file request message
+ + +| Field | Type | Label | Description |
| request | +FileRequest | ++ | File request |
+
| page_size | +int32 | ++ | Page size |
+
| marker | +string | ++ | Marker |
+
ListFileResp
+List file response message
+ + +| Field | Type | Label | Description |
| files | +FileInfo | +repeated | +File info |
+
| marker | +string | ++ | Marker |
+
| is_truncated | +bool | ++ | Is truncated |
+
LockKeepAliveRequest
+LockKeepAlive request message
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The lock store name,e.g. `redis`. |
+
| resource_id | +string | ++ | Required. resource_id is the lock key. |
+
| lock_owner | +string | ++ | Required. The owner of the lock. |
+
| expire | +int32 | ++ | Required. expire is the time before expire.The time unit is second. |
+
LockKeepAliveResponse
+LockKeepAlive response message
+ + +| Field | Type | Label | Description |
| status | +LockKeepAliveResponse.Status | ++ | The status of LockKeepAlive |
+
PublishEventRequest
+PublishEventRequest is the message to publish event data to pubsub topic
+ + +| Field | Type | Label | Description |
| pubsub_name | +string | ++ | The name of the pubsub component |
+
| topic | +string | ++ | The pubsub topic |
+
| data | +bytes | ++ | The data which will be published to topic. |
+
| data_content_type | +string | ++ | The content type for the data (optional). |
+
| metadata | +PublishEventRequest.MetadataEntry | +repeated | +The metadata passing to pub components + +metadata property: +- key : the key of the message. |
+
PublishEventRequest.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
PutFileRequest
+Put file request message
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | The name of store |
+
| name | +string | ++ | The name of the file or object want to put. |
+
| data | +bytes | ++ | The data will be store. |
+
| metadata | +PutFileRequest.MetadataEntry | +repeated | +The metadata for user extension. |
+
PutFileRequest.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
SaveConfigurationRequest
+SaveConfigurationRequest is the message to save a list of key-value configuration into specified configuration store.
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | The name of configuration store. |
+
| app_id | +string | ++ | The application id which +Only used for admin, ignored and reset for normal client |
+
| items | +ConfigurationItem | +repeated | +The list of configuration items to save. +To delete a exist item, set the key (also label) and let content to be empty |
+
| metadata | +SaveConfigurationRequest.MetadataEntry | +repeated | +The metadata which will be sent to configuration store components. |
+
SaveConfigurationRequest.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
SaveStateRequest
+SaveStateRequest is the message to save multiple states into state store.
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of state store. |
+
| states | +StateItem | +repeated | +Required. The array of the state key values. |
+
SayHelloRequest
+Hello request message
+ + +| Field | Type | Label | Description |
| service_name | +string | ++ | The name of service |
+
| name | +string | ++ | Reuqest name |
+
| data | +google.protobuf.Any | ++ | Optional. This field is used to control the packet size during load tests. |
+
SayHelloResponse
+Hello response message
+ + +| Field | Type | Label | Description |
| hello | +string | ++ | Hello |
+
| data | +google.protobuf.Any | ++ | Hello message of data |
+
SecretResponse
+SecretResponse is a map of decrypted string/string values
+ + +| Field | Type | Label | Description |
| secrets | +SecretResponse.SecretsEntry | +repeated | +The data struct of secrets |
+
SecretResponse.SecretsEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
SequencerOptions
+SequencerOptions configures requirements for auto-increment guarantee
+ + +| Field | Type | Label | Description |
| increment | +SequencerOptions.AutoIncrement | ++ | Default STRONG auto-increment |
+
StateItem
+StateItem represents state key, value, and additional options to save state.
+ + +| Field | Type | Label | Description |
| key | +string | ++ | Required. The state key |
+
| value | +bytes | ++ | Required. The state data for key |
+
| etag | +Etag | ++ | (optional) The entity tag which represents the specific version of data. +The exact ETag format is defined by the corresponding data store. Layotto runtime only treats ETags as opaque strings. |
+
| metadata | +StateItem.MetadataEntry | +repeated | +(optional) additional key-value pairs to be passed to the state store. |
+
| options | +StateOptions | ++ | (optional) Options for concurrency and consistency to save the state. |
+
StateItem.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
StateOptions
+StateOptions configures concurrency and consistency for state operations
+ + +| Field | Type | Label | Description |
| concurrency | +StateOptions.StateConcurrency | ++ | The state operation of concurrency |
+
| consistency | +StateOptions.StateConsistency | ++ | The state operation of consistency |
+
SubscribeConfigurationRequest
+SubscribeConfigurationRequest is the message to get a list of key-value configuration from specified configuration store.
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | The name of configuration store. |
+
| app_id | +string | ++ | The application id which +Only used for admin, ignored and reset for normal client |
+
| group | +string | ++ | The group of keys. |
+
| label | +string | ++ | The label for keys. |
+
| keys | +string | +repeated | +The keys to get. |
+
| metadata | +SubscribeConfigurationRequest.MetadataEntry | +repeated | +The metadata which will be sent to configuration store components. |
+
SubscribeConfigurationRequest.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
SubscribeConfigurationResponse
+SubscribeConfigurationResponse is the response conveying the list of configuration values.
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | The name of configuration store. |
+
| app_id | +string | ++ | The application id. +Only used for admin client. |
+
| items | +ConfigurationItem | +repeated | +The list of items containing configuration values. |
+
TransactionalStateOperation
+TransactionalStateOperation is the message to execute a specified operation with a key-value pair.
+ + +| Field | Type | Label | Description |
| operationType | +string | ++ | Required. The type of operation to be executed. +Legal values include: +"upsert" represents an update or create operation +"delete" represents a delete operation |
+
| request | +StateItem | ++ | Required. State values to be operated on |
+
TryLockRequest
+Lock request message is distributed lock API which is not blocking method tring to get a lock with ttl
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The lock store name,e.g. `redis`. |
+
| resource_id | +string | ++ | Required. resource_id is the lock key. e.g. `order_id_111` +It stands for "which resource I want to protect" |
+
| lock_owner | +string | ++ | Required. lock_owner indicate the identifier of lock owner. +You can generate a uuid as lock_owner.For example,in golang: +req.LockOwner = uuid.New().String() +This field is per request,not per process,so it is different for each request, +which aims to prevent multi-thread in the same process trying the same lock concurrently. +The reason why we don't make it automatically generated is: +1. If it is automatically generated,there must be a 'my_lock_owner_id' field in the response. +This name is so weird that we think it is inappropriate to put it into the api spec +2. If we change the field 'my_lock_owner_id' in the response to 'lock_owner',which means the current lock owner of this lock, +we find that in some lock services users can't get the current lock owner.Actually users don't need it at all. +3. When reentrant lock is needed,the existing lock_owner is required to identify client and check "whether this client can reenter this lock". +So this field in the request shouldn't be removed. |
+
| expire | +int32 | ++ | Required. expire is the time before expire.The time unit is second. |
+
TryLockResponse
+Lock response message returns is the lock obtained.
+ + +| Field | Type | Label | Description |
| success | +bool | ++ | Is lock success |
+
UnlockRequest
+UnLock request message
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | The name of store |
+
| resource_id | +string | ++ | resource_id is the lock key. |
+
| lock_owner | +string | ++ | The owner of the lock |
+
UnlockResponse
+UnLock response message
+ + +| Field | Type | Label | Description |
| status | +UnlockResponse.Status | ++ | The status of unlock |
+
HTTPExtension.Verb
+The enum of http reuest method
+| Name | Number | Description |
| NONE | +0 | +NONE |
+
| GET | +1 | +GET method |
+
| HEAD | +2 | +HEAD method |
+
| POST | +3 | +POST method |
+
| PUT | +4 | +PUT method |
+
| DELETE | +5 | +DELETE method |
+
| CONNECT | +6 | +CONNECT method |
+
| OPTIONS | +7 | +CONNECT method |
+
| TRACE | +8 | +CONNECT method |
+
| PATCH | +9 | +PATCH method |
+
LockKeepAliveResponse.Status
+The enum of LockKeepAlive status
+| Name | Number | Description |
| SUCCESS | +0 | +Lease renewal success |
+
| LOCK_UNEXIST | +1 | +The lock is not exist |
+
| LOCK_BELONG_TO_OTHERS | +2 | +The lock is belong to others |
+
| INTERNAL_ERROR | +3 | +Internal error |
+
SequencerOptions.AutoIncrement
+requirements for auto-increment guarantee
+| Name | Number | Description |
| WEAK | +0 | +(default) WEAK means a "best effort" incrementing service.But there is no strict guarantee of global monotonically increasing. +The next id is "probably" greater than current id. |
+
| STRONG | +1 | +STRONG means a strict guarantee of global monotonically increasing. +The next id "must" be greater than current id. |
+
StateOptions.StateConcurrency
+Enum describing the supported concurrency for state.
The API server uses Optimized Concurrency Control (OCC) with ETags.
When an ETag is associated with an save or delete request, the store shall allow the update only if the attached ETag matches with the latest ETag in the database.
But when ETag is missing in the write requests, the state store shall handle the requests in the specified strategy(e.g. a last-write-wins fashion).
+| Name | Number | Description |
| CONCURRENCY_UNSPECIFIED | +0 | +Concurrency state is unspecified |
+
| CONCURRENCY_FIRST_WRITE | +1 | +First write wins |
+
| CONCURRENCY_LAST_WRITE | +2 | +Last write wins |
+
StateOptions.StateConsistency
+Enum describing the supported consistency for state.
+| Name | Number | Description |
| CONSISTENCY_UNSPECIFIED | +0 | +Consistency state is unspecified |
+
| CONSISTENCY_EVENTUAL | +1 | +The API server assumes data stores are eventually consistent by default.A state store should: +- For read requests, the state store can return data from any of the replicas +- For write request, the state store should asynchronously replicate updates to configured quorum after acknowledging the update request. |
+
| CONSISTENCY_STRONG | +2 | +When a strong consistency hint is attached, a state store should: +- For read requests, the state store should return the most up-to-date data consistently across replicas. +- For write/delete requests, the state store should synchronisely replicate updated data to configured quorum before completing the write request. |
+
UnlockResponse.Status
+The enum of unlock status
+| Name | Number | Description |
| SUCCESS | +0 | +Unlock is success |
+
| LOCK_UNEXIST | +1 | +The lock is not exist |
+
| LOCK_BELONG_TO_OTHERS | +2 | +The lock is belong to others |
+
| INTERNAL_ERROR | +3 | +Internal error |
+
Protocol Documentation
+ +Table of Contents
+ +
+
+
+
+
+ -
+
+
+
-
+ oss.proto
+
-
+
+
+
- + SObjectStorageService + + +
+
+
+
+
+ oss.proto
Top +The file defined base on s3 protocol, to get an in-depth walkthrough of this file, see:
https://docs.aws.amazon.com/s3/index.html
https://github.com/aws/aws-sdk-go-v2
+ + +[gRPC Service] ObjectStorageService
+ObjectStorageService is an abstraction for blob storage or so called "object storage", such as alibaba cloud OSS, such as AWS S3.
You invoke ObjectStorageService API to do some CRUD operations on your binary file, e.g. query my file, delete my file, etc.
+| Method Name | Request Type | Response Type | Description |
| PutObject | +PutObjectInput stream | +PutObjectOutput | +Object CRUD API +Adds an object to a bucket. +Refer https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html |
+
| GetObject | +GetObjectInput | +GetObjectOutput stream | +Retrieves objects. +Refer https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html |
+
| DeleteObject | +DeleteObjectInput | +DeleteObjectOutput | +Delete objects. +Refer https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html |
+
| CopyObject | +CopyObjectInput | +CopyObjectOutput | +Creates a copy of an object that is already stored in oss server. +Refer https://docs.aws.amazon.com/zh_cn/AmazonS3/latest/API/API_CopyObject.html |
+
| DeleteObjects | +DeleteObjectsInput | +DeleteObjectsOutput | +Delete multiple objects from a bucket. +Refer https://docs.aws.amazon.com/zh_cn/AmazonS3/latest/API/API_DeleteObjects.html |
+
| ListObjects | +ListObjectsInput | +ListObjectsOutput | +Returns some or all (up to 1,000) of the objects in a bucket. +Refer https://docs.aws.amazon.com/zh_cn/AmazonS3/latest/API/API_ListObjects.html |
+
| HeadObject | +HeadObjectInput | +HeadObjectOutput | +The HEAD action retrieves metadata from an object without returning the object itself. +Refer https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html |
+
| IsObjectExist | +IsObjectExistInput | +IsObjectExistOutput | +This action used to check if the file exists. |
+
| PutObjectTagging | +PutObjectTaggingInput | +PutObjectTaggingOutput | +Object Tagging API +Sets the supplied tag-set to an object that already exists in a bucket. +Refer https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html |
+
| DeleteObjectTagging | +DeleteObjectTaggingInput | +DeleteObjectTaggingOutput | +Removes the entire tag set from the specified object. +Refer https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html |
+
| GetObjectTagging | +GetObjectTaggingInput | +GetObjectTaggingOutput | +Returns the tag-set of an object. +Refer https://docs.aws.amazon.com/zh_cn/AmazonS3/latest/API/API_GetObjectTagging.html |
+
| GetObjectCannedAcl | +GetObjectCannedAclInput | +GetObjectCannedAclOutput | +Returns object canned acl. +Refer https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#CannedACL |
+
| PutObjectCannedAcl | +PutObjectCannedAclInput | +PutObjectCannedAclOutput | +Set object canned acl. +Refer https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#CannedACL |
+
| CreateMultipartUpload | +CreateMultipartUploadInput | +CreateMultipartUploadOutput | +Object Multipart Operation API +Initiates a multipart upload and returns an upload ID. +Refer https://docs.aws.amazon.com/zh_cn/AmazonS3/latest/API/API_CreateMultipartUpload.html |
+
| UploadPart | +UploadPartInput stream | +UploadPartOutput | +Uploads a part in a multipart upload. +Refer https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html |
+
| UploadPartCopy | +UploadPartCopyInput | +UploadPartCopyOutput | +Uploads a part by copying data from an existing object as data source. +Refer https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html |
+
| CompleteMultipartUpload | +CompleteMultipartUploadInput | +CompleteMultipartUploadOutput | +Completes a multipart upload by assembling previously uploaded parts. +Refer https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html |
+
| AbortMultipartUpload | +AbortMultipartUploadInput | +AbortMultipartUploadOutput | +This action aborts a multipart upload. +Refer https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html |
+
| ListMultipartUploads | +ListMultipartUploadsInput | +ListMultipartUploadsOutput | +This action lists in-progress multipart uploads. +Refer https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html |
+
| ListParts | +ListPartsInput | +ListPartsOutput | +Lists the parts that have been uploaded for a specific multipart upload. +Refer https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html |
+
| ListObjectVersions | +ListObjectVersionsInput | +ListObjectVersionsOutput | +Returns metadata about all versions of the objects in a bucket. +Refer https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectVersions.html |
+
| SignURL | +SignURLInput | +SignURLOutput | +A presigned URL gives you access to the object identified in the URL, provided that the creator of the presigned URL has permissions to access that object. +Refer https://docs.aws.amazon.com/AmazonS3/latest/userguide/PresignedUrlUploadObject.html |
+
| UpdateDownloadBandwidthRateLimit | +UpdateBandwidthRateLimitInput | +.google.protobuf.Empty | +This action used to set download bandwidth limit speed. +Refer https://github.com/aliyun/aliyun-oss-go-sdk/blob/master/oss/client.go#L2106 |
+
| UpdateUploadBandwidthRateLimit | +UpdateBandwidthRateLimitInput | +.google.protobuf.Empty | +This action used to set upload bandwidth limit speed. +Refer https://github.com/aliyun/aliyun-oss-go-sdk/blob/master/oss/client.go#L2096 |
+
| AppendObject | +AppendObjectInput stream | +AppendObjectOutput | +This action is used to append object. +Refer https://help.aliyun.com/document_detail/31981.html or https://github.com/minio/minio-java/issues/980 |
+
| RestoreObject | +RestoreObjectInput | +RestoreObjectOutput | +Restores an archived copy of an object back. +Refer https://docs.aws.amazon.com/zh_cn/AmazonS3/latest/API/API_RestoreObject.html |
+
AbortMultipartUploadInput
+AbortMultipartUploadInput
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of oss store. |
+
| bucket | +string | ++ | The bucket name containing the object +This member is required |
+
| key | +string | ++ | Name of the object key. +This member is required. |
+
| expected_bucket_owner | +string | ++ | The account ID of the expected bucket owner |
+
| request_payer | +string | ++ | Confirms that the requester knows that they will be charged for the request. |
+
| upload_id | +string | ++ | Upload ID that identifies the multipart upload. +This member is required. |
+
AbortMultipartUploadOutput
+AbortMultipartUploadOutput
+ + +| Field | Type | Label | Description |
| request_charged | +string | ++ | If present, indicates that the requester was successfully charged for the request. |
+
AppendObjectInput
+AppendObjectInput
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of oss store. |
+
| bucket | +string | ++ | The bucket name containing the object +This member is required |
+
| key | +string | ++ | Name of the object key. +This member is required. |
+
| body | +bytes | ++ | Object content |
+
| position | +int64 | ++ | Append start position |
+
| acl | +string | ++ | Object ACL |
+
| cache_control | +string | ++ | Sets the Cache-Control header of the response. |
+
| content_disposition | +string | ++ | Sets the Content-Disposition header of the response |
+
| content_encoding | +string | ++ | Sets the Content-Encoding header of the response |
+
| content_md5 | +string | ++ | The base64-encoded 128-bit MD5 digest of the part data. |
+
| expires | +int64 | ++ | Sets the Expires header of the response |
+
| storage_class | +string | ++ | Provides storage class information of the object. Amazon S3 returns this header +for all objects except for S3 Standard storage class objects. |
+
| server_side_encryption | +string | ++ | The server-side encryption algorithm used when storing this object in Amazon S3 +(for example, AES256, aws:kms). |
+
| meta | +string | ++ | Object metadata |
+
| tags | +AppendObjectInput.TagsEntry | +repeated | +Object tags |
+
AppendObjectInput.TagsEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
AppendObjectOutput
+AppendObjectOutput
+ + +| Field | Type | Label | Description |
| append_position | +int64 | ++ | Next append position |
+
CSVInput
+CSVInput
+ + +| Field | Type | Label | Description |
| allow_quoted_record_delimiter | +bool | ++ | Specifies that CSV field values may contain quoted record delimiters and such +records should be allowed. Default value is FALSE. Setting this value to TRUE +may lower performance. |
+
| comments | +string | ++ | A single character used to indicate that a row should be ignored when the +character is present at the start of that row. You can specify any character to +indicate a comment line. |
+
| field_delimiter | +string | ++ | A single character used to separate individual fields in a record. You can +specify an arbitrary delimiter. |
+
| file_header_info | +string | ++ | Describes the first line of input. Valid values are: + +* NONE: First line is not +a header. + +* IGNORE: First line is a header, but you can't use the header values +to indicate the column in an expression. You can use column position (such as +_1, _2, …) to indicate the column (SELECT s._1 FROM OBJECT s). + +* Use: First +line is a header, and you can use the header value to identify a column in an +expression (SELECT "name" FROM OBJECT). |
+
| quote_character | +string | ++ | A single character used for escaping when the field delimiter is part of the +value. For example, if the value is a, b, Amazon S3 wraps this field value in +quotation marks, as follows: " a , b ". Type: String Default: " Ancestors: CSV |
+
| quote_escape_character | +string | ++ | A single character used for escaping the quotation mark character inside an +already escaped value. For example, the value """ a , b """ is parsed as " a , b +". |
+
| record_delimiter | +string | ++ | A single character used to separate individual records in the input. Instead of +the default value, you can specify an arbitrary delimiter. |
+
CSVOutput
+CSVOutput
+ + +| Field | Type | Label | Description |
| field_delimiter | +string | ++ | The value used to separate individual fields in a record. You can specify an +arbitrary delimiter. |
+
| quote_character | +string | ++ | A single character used for escaping when the field delimiter is part of the +value. For example, if the value is a, b, Amazon S3 wraps this field value in +quotation marks, as follows: " a , b ". |
+
| quote_escape_character | +string | ++ | The single character used for escaping the quote character inside an already +escaped value. |
+
| quote_fields | +string | ++ | Indicates whether to use quotation marks around output fields. + +* ALWAYS: Always +use quotation marks for output fields. + +* ASNEEDED: Use quotation marks for +output fields when needed. |
+
| record_delimiter | +string | ++ | A single character used to separate individual records in the output. Instead of +the default value, you can specify an arbitrary delimiter. |
+
CompleteMultipartUploadInput
+CompleteMultipartUploadInput
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of oss store. |
+
| bucket | +string | ++ | The bucket name containing the object +This member is required |
+
| key | +string | ++ | Name of the object key. +This member is required. |
+
| upload_id | +string | ++ | ID for the initiated multipart upload. +This member is required. |
+
| request_payer | +string | ++ | Confirms that the requester knows that they will be charged for the request. |
+
| expected_bucket_owner | +string | ++ | Expected bucket owner |
+
| multipart_upload | +CompletedMultipartUpload | ++ | The container for the multipart upload request information. |
+
CompleteMultipartUploadOutput
+CompleteMultipartUploadOutput
+ + +| Field | Type | Label | Description |
| bucket | +string | ++ | The bucket name containing the object +This member is required |
+
| key | +string | ++ | Name of the object key. +This member is required. |
+
| bucket_key_enabled | +bool | ++ | Indicates whether the multipart upload uses an S3 Bucket Key for server-side +encryption with Amazon Web Services KMS (SSE-KMS). |
+
| etag | +string | ++ | Entity tag that identifies the newly created object's data |
+
| expiration | +string | ++ | If the object expiration is configured, this will contain the expiration date +(expiry-date) and rule ID (rule-id). The value of rule-id is URL-encoded. |
+
| location | +string | ++ | The URI that identifies the newly created object. |
+
| request_charged | +string | ++ | If present, indicates that the requester was successfully charged for the +request. |
+
| sse_kms_keyId | +string | ++ | If present, specifies the ID of the Amazon Web Services Key Management Service +(Amazon Web Services KMS) symmetric customer managed key that was used for the +object. |
+
| server_side_encryption | +string | ++ | The server-side encryption algorithm used when storing this object in Amazon S3 +(for example, AES256, aws:kms). |
+
| version_id | +string | ++ | Version ID of the newly created object, in case the bucket has versioning turned +on. |
+
CompletedMultipartUpload
+CompletedMultipartUpload
+ + +| Field | Type | Label | Description |
| parts | +CompletedPart | +repeated | +Array of CompletedPart data types. |
+
CompletedPart
+CompletedPart
+ + +| Field | Type | Label | Description |
| etag | +string | ++ | Entity tag returned when the part was uploaded. |
+
| part_number | +int32 | ++ | Part number that identifies the part. This is a positive integer between 1 and +10,000. |
+
CopyObjectInput
+CopyObjectInput
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of oss store. |
+
| bucket | +string | ++ | The name of the destination bucket. When using this action with an access point +This member is required. |
+
| key | +string | ++ | The key of the destination object. +This member is required. |
+
| copy_source | +CopySource | ++ | CopySource |
+
| tagging | +CopyObjectInput.TaggingEntry | +repeated | +The tag-set for the object destination object this value must be used in +conjunction with the TaggingDirective. The tag-set must be encoded as URL Query +parameters. |
+
| expires | +int64 | ++ | The date and time at which the object is no longer cacheable. |
+
| metadata_directive | +string | ++ | Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request. |
+
| metadata | +CopyObjectInput.MetadataEntry | +repeated | +A map of metadata to store with the object in S3. |
+
CopyObjectInput.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
CopyObjectInput.TaggingEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
CopyObjectOutput
+CopyObjectOutput
+ + +| Field | Type | Label | Description |
| copy_object_result | +CopyObjectResult | ++ | Container for all response elements. |
+
| version_id | +string | ++ | Version ID of the newly created copy. |
+
| expiration | +string | ++ | If the object expiration is configured, the response includes this header. |
+
CopyObjectResult
+CopyObjectResult
+ + +| Field | Type | Label | Description |
| etag | +string | ++ | Returns the ETag of the new object. The ETag reflects only changes to the +contents of an object, not its metadata. |
+
| last_modified | +int64 | ++ | Creation date of the object. |
+
CopyPartResult
+CopyPartResult
+ + +| Field | Type | Label | Description |
| etag | +string | ++ | Entity tag of the object. |
+
| last_modified | +int64 | ++ | Last modified time |
+
CopySource
+CopySource
+ + +| Field | Type | Label | Description |
| copy_source_bucket | +string | ++ | source object bucket name |
+
| copy_source_key | +string | ++ | source object name |
+
| copy_source_version_id | +string | ++ | source object version |
+
CreateMultipartUploadInput
+CreateMultipartUploadInput
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of oss store. |
+
| bucket | +string | ++ | The bucket name containing the object +This member is required |
+
| key | +string | ++ | Name of the object key. +This member is required. |
+
| acl | +string | ++ | The canned ACL to apply to the object. This action is not supported by Amazon S3 +on Outposts. |
+
| bucket_key_enabled | +bool | ++ | Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption +with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true +causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. +Specifying this header with a PUT action doesn’t affect bucket-level settings +for S3 Bucket Key. |
+
| cache_control | +string | ++ | Specifies caching behavior along the request/reply chain |
+
| content_disposition | +string | ++ | Specifies presentational information for the object |
+
| content_encoding | +string | ++ | Specifies what content encodings have been applied to the object and thus what +decoding mechanisms must be applied to obtain the media-type referenced by the +Content-Type header field. |
+
| content_language | +string | ++ | The language the content is in. |
+
| content_type | +string | ++ | A standard MIME type describing the format of the object data. |
+
| expected_bucket_owner | +string | ++ | The account ID of the expected bucket owner. If the bucket is owned by a +different account, the request fails with the HTTP status code 403 Forbidden +(access denied). |
+
| expires | +int64 | ++ | The date and time at which the object is no longer cacheable. |
+
| grant_full_control | +string | ++ | Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object. This +action is not supported by Amazon S3 on Outposts. |
+
| grant_read | +string | ++ | Allows grantee to read the object data and its metadata. This action is not +supported by Amazon S3 on Outposts. |
+
| grant_read_acp | +string | ++ | Allows grantee to read the object ACL. This action is not supported by Amazon S3 +on Outposts. |
+
| grant_write_acp | +string | ++ | Allows grantee to write the ACL for the applicable object. This action is not +supported by Amazon S3 on Outposts. |
+
| meta_data | +CreateMultipartUploadInput.MetaDataEntry | +repeated | +A map of metadata to store with the object |
+
| object_lock_legal_hold_status | +string | ++ | Specifies whether you want to apply a legal hold to the uploaded object |
+
| object_lock_mode | +string | ++ | Specifies the Object Lock mode that you want to apply to the uploaded object |
+
| object_lock_retain_until_date | +int64 | ++ | Specifies the date and time when you want the Object Lock to expire |
+
| request_payer | +string | ++ | Confirms that the requester knows that they will be charged for the request |
+
| sse_customer_algorithm | +string | ++ | Specifies the algorithm to use to when encrypting the object (for example, +AES256). |
+
| sse_customer_key | +string | ++ | Specifies the customer-provided encryption key to use in encrypting data |
+
| sse_customer_key_md5 | +string | ++ | Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321 |
+
| sse_kms_encryption_context | +string | ++ | Specifies the Amazon Web Services KMS Encryption Context to use for object encryption |
+
| sse_kms_key_id | +string | ++ | Specifies the ID of the symmetric customer managed key to use for object encryption |
+
| server_side_encryption | +string | ++ | The server-side encryption algorithm used when storing this object |
+
| storage_class | +string | ++ | By default, oss store uses the STANDARD Storage Class to store newly created objects |
+
| tagging | +CreateMultipartUploadInput.TaggingEntry | +repeated | +The tag-set for the object. The tag-set must be encoded as URL Query parameters. |
+
| website_redirect_location | +string | ++ | If the bucket is configured as a website, redirects requests for this object to +another object in the same bucket or to an external URL. |
+
CreateMultipartUploadInput.MetaDataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
CreateMultipartUploadInput.TaggingEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
CreateMultipartUploadOutput
+CreateMultipartUploadOutput
+ + +| Field | Type | Label | Description |
| bucket | +string | ++ | The bucket name containing the object +This member is required |
+
| key | +string | ++ | Name of the object key. +This member is required. |
+
| abort_date | +int64 | ++ | If the bucket has a lifecycle rule configured with an action to abort incomplete +multipart uploads and the prefix in the lifecycle rule matches the object name +in the request, the response includes this header |
+
| abort_rule_id | +string | ++ | It identifies the applicable lifecycle configuration rule that defines the action to abort +incomplete multipart uploads. |
+
| bucket_key_enabled | +bool | ++ | Indicates whether the multipart upload uses an S3 Bucket Key for server-side +encryption with Amazon Web Services KMS (SSE-KMS). |
+
| request_charged | +string | ++ | If present, indicates that the requester was successfully charged for the +request. |
+
| sse_customer_algorithm | +string | ++ | If server-side encryption with a customer-provided encryption key was requested, +the response will include this header confirming the encryption algorithm used. |
+
| sse_customer_key_md5 | +string | ++ | If server-side encryption with a customer-provided encryption key was requested, +the response will include this header to provide round-trip message integrity +verification of the customer-provided encryption key. |
+
| sse_kms_encryption_context | +string | ++ | If present, specifies the Amazon Web Services KMS Encryption Context to use for +object encryption. The value of this header is a base64-encoded UTF-8 string +holding JSON with the encryption context key-value pairs. |
+
| sse_kms_key_id | +string | ++ | If present, specifies the ID of the Amazon Web Services Key Management Service +(Amazon Web Services KMS) symmetric customer managed key that was used for the +object. |
+
| server_side_encryption | +string | ++ | The server-side encryption algorithm used when storing this object in Amazon S3 +(for example, AES256, aws:kms). |
+
| upload_id | +string | ++ | ID for the initiated multipart upload. |
+
Delete
+Delete
+ + +| Field | Type | Label | Description |
| objects | +ObjectIdentifier | +repeated | +ObjectIdentifier |
+
| quiet | +bool | ++ | Element to enable quiet mode for the request. When you add this element, you +must set its value to true. |
+
DeleteMarkerEntry
+DeleteMarkerEntry
+ + +| Field | Type | Label | Description |
| is_latest | +bool | ++ | Specifies whether the object is (true) or is not (false) the latest version of +an object. |
+
| key | +string | ++ | Name of the object key. +This member is required. |
+
| last_modified | +int64 | ++ | Date and time the object was last modified. |
+
| owner | +Owner | ++ | Owner |
+
| version_id | +string | ++ | Version ID of an object. |
+
DeleteObjectInput
+DeleteObjectInput
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of oss store. |
+
| bucket | +string | ++ | The bucket name to which the DEL action was initiated +This member is required. |
+
| key | +string | ++ | Object key for which the DEL action was initiated. +This member is required. |
+
| request_payer | +string | ++ | Confirms that the requester knows that they will be charged for the request. |
+
| version_id | +string | ++ | VersionId used to reference a specific version of the object. |
+
DeleteObjectOutput
+DeleteObjectOutput
+ + +| Field | Type | Label | Description |
| delete_marker | +bool | ++ | Specifies whether the versioned object that was permanently deleted was (true) +or was not (false) a delete marker. |
+
| request_charged | +string | ++ | If present, indicates that the requester was successfully charged for the +request. |
+
| version_id | +string | ++ | Returns the version ID of the delete marker created as a result of the DELETE +operation. |
+
DeleteObjectTaggingInput
+DeleteObjectTaggingInput
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of oss store. |
+
| bucket | +string | ++ | The bucket name containing the objects from which to remove the tags. |
+
| key | +string | ++ | The key that identifies the object in the bucket from which to remove all tags. +This member is required. |
+
| version_id | +string | ++ | The versionId of the object that the tag-set will be removed from. |
+
| expected_bucket_owner | +string | ++ | The account ID of the expected bucket owner. If the bucket is owned by a +different account, the request fails with the HTTP status code 403 Forbidden +(access denied). |
+
DeleteObjectTaggingOutput
+DeleteObjectTaggingOutput
+ + +| Field | Type | Label | Description |
| version_id | +string | ++ | The versionId of the object the tag-set was removed from. |
+
| result_metadata | +DeleteObjectTaggingOutput.ResultMetadataEntry | +repeated | +Metadata pertaining to the operation's result. |
+
DeleteObjectTaggingOutput.ResultMetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
DeleteObjectsInput
+DeleteObjectsInput
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of oss store. |
+
| bucket | +string | ++ | The bucket name containing the object +This member is required |
+
| delete | +Delete | ++ | Delete objects |
+
| request_payer | +string | ++ | Confirms that the requester knows that they will be charged for the request. |
+
DeleteObjectsOutput
+DeleteObjectsOutput
+ + +| Field | Type | Label | Description |
| deleted | +DeletedObject | +repeated | +DeletedObject |
+
DeletedObject
+DeletedObject
+ + +| Field | Type | Label | Description |
| delete_marker | +bool | ++ | Specifies whether the versioned object that was permanently deleted was (true) +or was not (false) a delete marker. In a simple DELETE, this header indicates +whether (true) or not (false) a delete marker was created. |
+
| delete_marker_version_id | +string | ++ | The version ID of the delete marker created as a result of the DELETE operation. +If you delete a specific object version, the value returned by this header is +the version ID of the object version deleted. |
+
| key | +string | ++ | The name of the deleted object. |
+
| version_id | +string | ++ | The version ID of the deleted object. |
+
GetObjectCannedAclInput
+GetObjectCannedAclInput
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of oss store. |
+
| bucket | +string | ++ | The bucket name containing the object +This member is required |
+
| key | +string | ++ | Name of the object key. +This member is required. |
+
| version_id | +string | ++ | VersionId used to reference a specific version of the object |
+
GetObjectCannedAclOutput
+GetObjectCannedAclOutput
+ + +| Field | Type | Label | Description |
| canned_acl | +string | ++ | Object CannedACL |
+
| owner | +Owner | ++ | Owner |
+
| request_charged | +string | ++ | If present, indicates that the requester was successfully charged for the +request. |
+
GetObjectInput
+GetObjectInput
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of oss store. |
+
| bucket | +string | ++ | The bucket name containing the object +This member is required |
+
| key | +string | ++ | Key of the object to get +This member is required |
+
| expected_bucket_owner | +string | ++ | The account ID of the expected bucket owner |
+
| if_match | +string | ++ | Return the object only if its entity tag (ETag) is the same as the one specified |
+
| if_modified_since | +int64 | ++ | Return the object only if it has been modified since the specified time |
+
| if_none_match | +string | ++ | Return the object only if its entity tag (ETag) is different from the one specified |
+
| if_unmodified_since | +int64 | ++ | Return the object only if it has not been modified since the specified time |
+
| part_number | +int64 | ++ | Part number of the object being read. This is a positive integer between 1 and +10,000. Effectively performs a 'ranged' GET request for the part specified. +Useful for downloading just a part of an object. |
+
| start | +int64 | ++ | Downloads the specified range bytes of an object +start is used to specify the location where the file starts |
+
| end | +int64 | ++ | end is used to specify the location where the file end |
+
| request_payer | +string | ++ | Confirms that the requester knows that they will be charged for the request. |
+
| response_cache_control | +string | ++ | Sets the Cache-Control header of the response. |
+
| response_content_disposition | +string | ++ | Sets the Content-Disposition header of the response |
+
| response_content_encoding | +string | ++ | Sets the Content-Encoding header of the response |
+
| response_content_language | +string | ++ | Sets the Content-Language header of the response |
+
| response_content_type | +string | ++ | Sets the Content-Type header of the response |
+
| response_expires | +string | ++ | Sets the Expires header of the response |
+
| sse_customer_algorithm | +string | ++ | Specifies the algorithm to use to when decrypting the object (for example,AES256) |
+
| sse_customer_key | +string | ++ | Specifies the customer-provided encryption key for Amazon S3 used to encrypt the +data. This value is used to decrypt the object when recovering it and must match +the one used when storing the data. The key must be appropriate for use with the +algorithm specified in the x-amz-server-side-encryption-customer-algorithm header |
+
| sse_customer_key_md5 | +string | ++ | Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321 +Amazon S3 uses this header for a message integrity check to ensure that the +encryption key was transmitted without error. |
+
| version_id | +string | ++ | VersionId used to reference a specific version of the object |
+
| accept_encoding | +string | ++ | Specify Accept-Encoding, aws not supported now |
+
| signed_url | +string | ++ | Specify the signed url of object, user can get object with signed url without ak、sk |
+
GetObjectOutput
+GetObjectOutput
+ + +| Field | Type | Label | Description |
| body | +bytes | ++ | Object data. |
+
| cache_control | +string | ++ | Specifies caching behavior along the request/reply chain. |
+
| content_disposition | +string | ++ | Specifies presentational information for the object. |
+
| content_encoding | +string | ++ | Specifies what content encodings have been applied to the object and thus what +decoding mechanisms must be applied to obtain the media-type referenced by the +Content-Type header field. |
+
| content_language | +string | ++ | The language the content is in. |
+
| content_length | +int64 | ++ | Size of the body in bytes. |
+
| content_range | +string | ++ | The portion of the object returned in the response. |
+
| content_type | +string | ++ | A standard MIME type describing the format of the object data. |
+
| delete_marker | +bool | ++ | Specifies whether the object retrieved was (true) or was not (false) a Delete +Marker. If false, this response header does not appear in the response. |
+
| etag | +string | ++ | An entity tag (ETag) is an opaque identifier assigned by a web server to a +specific version of a resource found at a URL. |
+
| expiration | +string | ++ | If the object expiration is configured (see PUT Bucket lifecycle), the response +includes this header. It includes the expiry-date and rule-id key-value pairs +providing object expiration information. The value of the rule-id is +URL-encoded. |
+
| expires | +string | ++ | The date and time at which the object is no longer cacheable. |
+
| last_modified | +int64 | ++ | Creation date of the object. |
+
| version_id | +string | ++ | Version of the object. |
+
| tag_count | +int64 | ++ | The number of tags, if any, on the object. |
+
| storage_class | +string | ++ | Provides storage class information of the object. Amazon S3 returns this header +for all objects except for S3 Standard storage class objects. |
+
| parts_count | +int64 | ++ | The count of parts this object has. This value is only returned if you specify +partNumber in your request and the object was uploaded as a multipart upload. |
+
| metadata | +GetObjectOutput.MetadataEntry | +repeated | +A map of metadata to store with the object in S3. +Map keys will be normalized to lower-case. |
+
GetObjectOutput.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
GetObjectTaggingInput
+GetObjectTaggingInput
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of oss store. |
+
| bucket | +string | ++ | The bucket name containing the object for which to get the tagging information. +This member is required. |
+
| key | +string | ++ | Object key for which to get the tagging information. +This member is required. |
+
| version_id | +string | ++ | The versionId of the object for which to get the tagging information. |
+
| expected_bucket_owner | +string | ++ | The account ID of the expected bucket owner. If the bucket is owned by a +different account, the request fails with the HTTP status code 403 Forbidden +(access denied). |
+
| request_payer | +string | ++ | Confirms that the requester knows that they will be charged for the request. |
+
GetObjectTaggingOutput
+GetObjectTaggingOutput
+ + +| Field | Type | Label | Description |
| tags | +GetObjectTaggingOutput.TagsEntry | +repeated | +Contains the tag set. +This member is required. |
+
| version_id | +string | ++ | The versionId of the object for which you got the tagging information. |
+
| result_metadata | +GetObjectTaggingOutput.ResultMetadataEntry | +repeated | +Metadata pertaining to the operation's result. |
+
GetObjectTaggingOutput.ResultMetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
GetObjectTaggingOutput.TagsEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
GlacierJobParameters
+GlacierJobParameters
+ + +| Field | Type | Label | Description |
| tier | +string | ++ | Retrieval tier at which the restore will be processed. +This member is required. |
+
HeadObjectInput
+HeadObjectInput
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of oss store. |
+
| bucket | +string | ++ | The bucket name containing the object +This member is required |
+
| key | +string | ++ | Name of the object key. +This member is required. |
+
| checksum_mode | +string | ++ | To retrieve the checksum, this parameter must be enabled |
+
| expected_bucket_owner | +string | ++ | The account ID of the expected bucket owner |
+
| if_match | +string | ++ | Return the object only if its entity tag (ETag) is the same as the one +specified; otherwise, return a 412 (precondition failed) error. |
+
| if_modified_since | +int64 | ++ | Return the object only if it has been modified since the specified time; +otherwise, return a 304 (not modified) error. |
+
| if_none_match | +string | ++ | Return the object only if its entity tag (ETag) is different from the one +specified |
+
| if_unmodified_since | +int64 | ++ | Return the object only if it has not been modified since the specified time; |
+
| part_number | +int32 | ++ | Part number of the object being read. This is a positive integer between 1 and +10,000. Effectively performs a 'ranged' HEAD request for the part specified. +Useful querying about the size of the part and the number of parts in this +object. |
+
| request_payer | +string | ++ | Confirms that the requester knows that they will be charged for the request. |
+
| sse_customer_algorithm | +string | ++ | Specifies the algorithm to use to when encrypting the object (for example, +AES256). |
+
| sse_customer_key | +string | ++ | Specifies the customer-provided encryption key for Amazon S3 to use in +encrypting data |
+
| sse_customer_key_md5 | +string | ++ | Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. |
+
| version_id | +string | ++ | VersionId used to reference a specific version of the object. |
+
| with_details | +bool | ++ | Return object details meta |
+
HeadObjectOutput
+HeadObjectOutput
+ + +| Field | Type | Label | Description |
| result_metadata | +HeadObjectOutput.ResultMetadataEntry | +repeated | +Metadata pertaining to the operation's result. |
+
HeadObjectOutput.ResultMetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
Initiator
+Initiator
+ + +| Field | Type | Label | Description |
| display_name | +string | ++ | Initiator name |
+
| id | +string | ++ | Initiator id |
+
InputSerialization
+InputSerialization
+ + +| Field | Type | Label | Description |
| csv | +CSVInput | ++ | Describes the serialization of a CSV-encoded object. |
+
| compression_type | +string | ++ | Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default +Value: NONE. |
+
| json | +string | ++ | Specifies JSON as object's input serialization format. |
+
IsObjectExistInput
+IsObjectExistInput
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of oss store. |
+
| bucket | +string | ++ | The bucket name containing the object +This member is required |
+
| key | +string | ++ | Name of the object key. +This member is required. |
+
| version_id | +string | ++ | Object version id |
+
IsObjectExistOutput
+IsObjectExistOutput
+ + +| Field | Type | Label | Description |
| file_exist | +bool | ++ | Object exist or not |
+
ListMultipartUploadsInput
+ListMultipartUploadsInput
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of oss store. |
+
| bucket | +string | ++ | The bucket name containing the object +This member is required |
+
| delimiter | +string | ++ | Character you use to group keys. All keys that contain the same string between +the prefix, if specified, and the first occurrence of the delimiter after the +prefix are grouped under a single result element, CommonPrefixes. If you don't +specify the prefix parameter, then the substring starts at the beginning of the +key. The keys that are grouped under CommonPrefixes result element are not +returned elsewhere in the response. |
+
| encoding_type | +string | ++ | Requests Amazon S3 to encode the object keys in the response and specifies the +encoding method to use. An object key may contain any Unicode character; |
+
| expected_bucket_owner | +string | ++ | The account ID of the expected bucket owner |
+
| key_marker | +string | ++ | Together with upload-id-marker, this parameter specifies the multipart upload +after which listing should begin. If upload-id-marker is not specified, only the +keys lexicographically greater than the specified key-marker will be included in +the list. If upload-id-marker is specified, any multipart uploads for a key +equal to the key-marker might also be included, provided those multipart uploads +have upload IDs lexicographically greater than the specified upload-id-marker. |
+
| max_uploads | +int64 | ++ | Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the +response body. 1,000 is the maximum number of uploads that can be returned in a +response. |
+
| prefix | +string | ++ | Lists in-progress uploads only for those keys that begin with the specified +prefix. You can use prefixes to separate a bucket into different grouping of +keys. (You can think of using prefix to make groups in the same way you'd use a +folder in a file system.) |
+
| upload_id_marker | +string | ++ | Together with key-marker, specifies the multipart upload after which listing +should begin. If key-marker is not specified, the upload-id-marker parameter is +ignored. Otherwise, any multipart uploads for a key equal to the key-marker +might be included in the list only if they have an upload ID lexicographically +greater than the specified upload-id-marker. |
+
ListMultipartUploadsOutput
+ListMultipartUploadsOutput
+ + +| Field | Type | Label | Description |
| bucket | +string | ++ | The bucket name containing the object +This member is required |
+
| common_prefixes | +string | +repeated | +If you specify a delimiter in the request, then the result returns each distinct +key prefix containing the delimiter in a CommonPrefixes element. |
+
| delimiter | +string | ++ | Contains the delimiter you specified in the request. If you don't specify a +delimiter in your request, this element is absent from the response. |
+
| encoding_type | +string | ++ | Encoding type used by Amazon S3 to encode object keys in the response. |
+
| is_truncated | +bool | ++ | Indicates whether the returned list of multipart uploads is truncated. A value +of true indicates that the list was truncated. The list can be truncated if the +number of multipart uploads exceeds the limit allowed or specified by max +uploads. |
+
| key_marker | +string | ++ | The key at or after which the listing began. |
+
| max_uploads | +int32 | ++ | Maximum number of multipart uploads that could have been included in the +response. |
+
| next_key_marker | +string | ++ | When a list is truncated, this element specifies the value that should be used +for the key-marker request parameter in a subsequent request. |
+
| next_upload_id_marker | +string | ++ | When a list is truncated, this element specifies the value that should be used +for the upload-id-marker request parameter in a subsequent request. |
+
| prefix | +string | ++ | When a prefix is provided in the request, this field contains the specified +prefix. The result contains only keys starting with the specified prefix. |
+
| upload_id_marker | +string | ++ | Upload ID after which listing began. |
+
| uploads | +MultipartUpload | +repeated | +Container for elements related to a particular multipart upload. A response can +contain zero or more Upload elements. |
+
ListObjectVersionsInput
+ListObjectVersionsInput
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of oss store. |
+
| bucket | +string | ++ | The bucket name containing the object +This member is required |
+
| delimiter | +string | ++ | A delimiter is a character that you specify to group keys. All keys that contain +the same string between the prefix and the first occurrence of the delimiter are +grouped under a single result element in CommonPrefixes. These groups are +counted as one result against the max-keys limitation. These keys are not +returned elsewhere in the response. |
+
| encoding_type | +string | ++ | Requests Amazon S3 to encode the object keys in the response and specifies the +encoding method to use. An object key may contain any Unicode character; |
+
| expected_bucket_owner | +string | ++ | The account ID of the expected bucket owner |
+
| key_marker | +string | ++ | Specifies the key to start with when listing objects in a bucket. |
+
| max_keys | +int64 | ++ | Sets the maximum number of keys returned in the response. By default the action +returns up to 1,000 key names. The response might contain fewer keys but will +never contain more. If additional keys satisfy the search criteria, but were not +returned because max-keys was exceeded, the response contains true. To return +the additional keys, see key-marker and version-id-marker. |
+
| prefix | +string | ++ | Use this parameter to select only those keys that begin with the specified +prefix. You can use prefixes to separate a bucket into different groupings of +keys. (You can think of using prefix to make groups in the same way you'd use a +folder in a file system.) You can use prefix with delimiter to roll up numerous +objects into a single result under CommonPrefixes. |
+
| version_id_marker | +string | ++ | Specifies the object version you want to start listing from. |
+
ListObjectVersionsOutput
+ListObjectVersionsOutput
+ + +| Field | Type | Label | Description |
| common_prefixes | +string | +repeated | +All of the keys rolled up into a common prefix count as a single return when +calculating the number of returns. |
+
| delete_markers | +DeleteMarkerEntry | +repeated | +Container for an object that is a delete marker. |
+
| delimiter | +string | ++ | The delimiter grouping the included keys. |
+
| encoding_type | +string | ++ | Encoding type used by Amazon S3 to encode object key names in the XML response. |
+
| is_truncated | +bool | ++ | A flag that indicates whether Amazon S3 returned all of the results that +satisfied the search criteria |
+
| key_marker | +string | ++ | Marks the last key returned in a truncated response. |
+
| max_keys | +int64 | ++ | Specifies the maximum number of objects to return |
+
| name | +string | ++ | The bucket name. |
+
| next_key_marker | +string | ++ | When the number of responses exceeds the value of MaxKeys, NextKeyMarker +specifies the first key not returned that satisfies the search criteria |
+
| next_version_id_marker | +string | ++ | When the number of responses exceeds the value of MaxKeys, NextVersionIdMarker +specifies the first object version not returned that satisfies the search +criteria. |
+
| prefix | +string | ++ | Selects objects that start with the value supplied by this parameter. |
+
| version_id_marker | +string | ++ | Marks the last version of the key returned in a truncated response. |
+
| versions | +ObjectVersion | +repeated | +Container for version information. |
+
ListObjectsInput
+ListObjectsInput
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of oss store. |
+
| bucket | +string | ++ | The bucket name containing the object +This member is required |
+
| delimiter | +string | ++ | A delimiter is a character you use to group keys. |
+
| encoding_type | +string | ++ | Requests Amazon S3 to encode the object keys in the response and specifies the +encoding method to use. An object key may contain any Unicode character; +however, XML 1.0 parser cannot parse some characters, such as characters with an +ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you +can add this parameter to request that Amazon S3 encode the keys in the +response. |
+
| expected_bucket_owner | +string | ++ | The account ID of the expected bucket owner. If the bucket is owned by a +different account, the request fails with the HTTP status code 403 Forbidden +(access denied). |
+
| marker | +string | ++ | Marker is where you want Amazon S3 to start listing from. Amazon S3 starts +listing after this specified key. Marker can be any key in the bucket. |
+
| maxKeys | +int32 | ++ | Sets the maximum number of keys returned in the response. By default the action +returns up to 1,000 key names. The response might contain fewer keys but will +never contain more. |
+
| prefix | +string | ++ | Limits the response to keys that begin with the specified prefix. |
+
| request_payer | +string | ++ | Confirms that the requester knows that they will be charged for the request. |
+
ListObjectsOutput
+ListObjectsOutput
+ + +| Field | Type | Label | Description |
| common_prefixes | +string | +repeated | +CommonPrefixes |
+
| contents | +Object | +repeated | +Objects contents |
+
| delimiter | +string | ++ | Causes keys that contain the same string between the prefix and the first +occurrence of the delimiter to be rolled up into a single result element in the +CommonPrefixes collection. These rolled-up keys are not returned elsewhere in +the response. Each rolled-up result counts as only one return against the +MaxKeys value. |
+
| encoding_type | +string | ++ | Encoding type used by Amazon S3 to encode object keys in the response. |
+
| is_truncated | +bool | ++ | A flag that indicates whether Amazon S3 returned all of the results that +satisfied the search criteria. |
+
| marker | +string | ++ | Indicates where in the bucket listing begins. Marker is included in the response +if it was sent with the request. |
+
| max_keys | +int32 | ++ | The maximum number of keys returned in the response body. |
+
| name | +string | ++ | The bucket name. |
+
| next_marker | +string | ++ | When response is truncated (the IsTruncated element value in the response is +true), you can use the key name in this field as marker in the subsequent +request to get next set of objects. |
+
| prefix | +string | ++ | Keys that begin with the indicated prefix. |
+
ListPartsInput
+ListPartsInput
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of oss store. |
+
| bucket | +string | ++ | The bucket name containing the object +This member is required |
+
| key | +string | ++ | Name of the object key. +This member is required. |
+
| expected_bucket_owner | +string | ++ | The account ID of the expected bucket owner |
+
| max_parts | +int64 | ++ | Sets the maximum number of parts to return |
+
| part_number_marker | +int64 | ++ | Specifies the part after which listing should begin. Only parts with higher part +numbers will be listed. |
+
| request_payer | +string | ++ | Confirms that the requester knows that they will be charged for the request. |
+
| upload_id | +string | ++ | Upload ID identifying the multipart upload whose parts are being listed. |
+
ListPartsOutput
+ListPartsOutput
+ + +| Field | Type | Label | Description |
| bucket | +string | ++ | The bucket name containing the object +This member is required |
+
| key | +string | ++ | Name of the object key. +This member is required. |
+
| upload_id | +string | ++ | Upload ID identifying the multipart upload whose parts are being listed. |
+
| next_part_number_marker | +string | ++ | When a list is truncated, this element specifies the last part in the list, as +well as the value to use for the part-number-marker request parameter in a +subsequent request. |
+
| max_parts | +int64 | ++ | Maximum number of parts that were allowed in the response. |
+
| is_truncated | +bool | ++ | Indicates whether the returned list of parts is truncated. A true value +indicates that the list was truncated. A list can be truncated if the number of +parts exceeds the limit returned in the MaxParts element. |
+
| parts | +Part | +repeated | +Container for elements related to a particular part. A response can contain zero +or more Part elements. |
+
MultipartUpload
+MultipartUpload
+ + +| Field | Type | Label | Description |
| initiated | +int64 | ++ | Date and time at which the multipart upload was initiated. |
+
| initiator | +Initiator | ++ | Identifies who initiated the multipart upload. |
+
| key | +string | ++ | Name of the object key. +This member is required. |
+
| owner | +Owner | ++ | Specifies the owner of the object that is part of the multipart upload. |
+
| storage_class | +string | ++ | The class of storage used to store the object. |
+
| upload_id | +string | ++ | Upload ID that identifies the multipart upload. |
+
Object
+Object
+ + +| Field | Type | Label | Description |
| etag | +string | ++ | The entity tag is a hash of the object |
+
| key | +string | ++ | The name that you assign to an object. You use the object key to retrieve the +object. |
+
| last_modified | +int64 | ++ | Creation date of the object. |
+
| owner | +Owner | ++ | The owner of the object |
+
| size | +int64 | ++ | Size in bytes of the object |
+
| storage_class | +string | ++ | The class of storage used to store the object. |
+
ObjectIdentifier
+ObjectIdentifier
+ + +| Field | Type | Label | Description |
| key | +string | ++ | Key name of the object. +This member is required. |
+
| version_id | +string | ++ | VersionId for the specific version of the object to delete. |
+
ObjectVersion
+ObjectVersion
+ + +| Field | Type | Label | Description |
| etag | +string | ++ | The entity tag is an MD5 hash of that version of the object. |
+
| is_latest | +bool | ++ | Specifies whether the object is (true) or is not (false) the latest version of +an object. |
+
| key | +string | ++ | Name of the object key. +This member is required. |
+
| last_modified | +int64 | ++ | Date and time the object was last modified. |
+
| owner | +Owner | ++ | Specifies the owner of the object. |
+
| size | +int64 | ++ | Size in bytes of the object. |
+
| storage_class | +string | ++ | The class of storage used to store the object. |
+
| version_id | +string | ++ | Version ID of an object. |
+
OutputLocation
+OutPutLocation
+ + +| Field | Type | Label | Description |
| bucket_name | +string | ++ | The name of the bucket where the restore results will be placed. +This member is required. |
+
| prefix | +string | ++ | The prefix that is prepended to the restore results for this request. +This member is required. |
+
OutputSerialization
+OutputSerialization
+ + +| Field | Type | Label | Description |
| csv | +CSVOutput | ++ | Describes the serialization of CSV-encoded Select results. |
+
| json | +string | ++ | Specifies JSON as request's output serialization format. |
+
Owner
+Owner
+ + +| Field | Type | Label | Description |
| display_name | +string | ++ | Owner display name |
+
| id | +string | ++ | Owner id |
+
Part
+Part
+ + +| Field | Type | Label | Description |
| etag | +string | ++ | Part Etag |
+
| last_modified | +int64 | ++ | Last modified time |
+
| part_number | +int64 | ++ | Part number |
+
| size | +int64 | ++ | Part size |
+
PutObjectCannedAclInput
+PutObjectCannedAclInput
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of oss store. |
+
| bucket | +string | ++ | The bucket name containing the object +This member is required |
+
| key | +string | ++ | Name of the object key. +This member is required. |
+
| acl | +string | ++ | The canned ACL to apply to the object |
+
| version_id | +string | ++ | VersionId used to reference a specific version of the object. |
+
PutObjectCannedAclOutput
+PutObjectCannedAclOutput
+ + +| Field | Type | Label | Description |
| request_charged | +string | ++ | Request charged |
+
PutObjectInput
+PutObjectInput
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of oss store. |
+
| body | +bytes | ++ | Object data. |
+
| bucket | +string | ++ | The bucket name to which the PUT action was initiated +This member is required. |
+
| key | +string | ++ | Object key for which the PUT action was initiated. +This member is required. |
+
| acl | +string | ++ | The canned ACL to apply to the object,different oss provider have different acl type |
+
| bucket_key_enabled | +bool | ++ | Indicates whether the multipart upload uses an S3 Bucket Key for server-side +encryption with Amazon Web Services KMS (SSE-KMS). |
+
| cache_control | +string | ++ | Can be used to specify caching behavior along the request/reply chain. |
+
| content_disposition | +string | ++ | Specifies presentational information for the object. For more information, see +http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1 +(http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1). |
+
| content_encoding | +string | ++ | Specifies what content encodings have been applied to the object and thus what +decoding mechanisms must be applied to obtain the media-type referenced by the +Content-Type header field. For more information, see +http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11 +(http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11). |
+
| expires | +int64 | ++ | The date and time at which the object is no longer cacheable. For more +information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21 +(http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21). |
+
| server_side_encryption | +string | ++ | The server-side encryption algorithm used when storing this object in Amazon S3 +(for example, AES256, aws:kms). |
+
| signed_url | +string | ++ | Specify the signed url of object, user can put object with signed url without ak、sk |
+
| meta | +PutObjectInput.MetaEntry | +repeated | +A map of metadata to store with the object in S3. |
+
| tagging | +PutObjectInput.TaggingEntry | +repeated | +The tag-set for the object. The tag-set must be encoded as URL Query parameters. |
+
| storage_class | +string | ++ | Storage class options. |
+
| content_length | +int64 | ++ | Size of the body in bytes. This parameter is useful when the size of the body +cannot be determined automatically |
+
PutObjectInput.MetaEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
PutObjectInput.TaggingEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
PutObjectOutput
+PutObjectOutput
+ + +| Field | Type | Label | Description |
| bucket_key_enabled | +bool | ++ | Indicates whether the uploaded object uses an S3 Bucket Key for server-side +encryption with Amazon Web Services KMS (SSE-KMS). |
+
| etag | +string | ++ | Entity tag for the uploaded object. |
+
| expiration | +string | ++ | If the expiration is configured for the object |
+
| request_charged | +string | ++ | If present, indicates that the requester was successfully charged for the request. |
+
| version_id | +string | ++ | Version of the object. |
+
PutObjectTaggingInput
+PutObjectTaggingInput
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of oss store. |
+
| bucket | +string | ++ | The bucket name containing the object +This member is required. |
+
| key | +string | ++ | Name of the object key. +This member is required. |
+
| tags | +PutObjectTaggingInput.TagsEntry | +repeated | +Container for the TagSet and Tag elements |
+
| version_id | +string | ++ | The versionId of the object that the tag-set will be added to. |
+
PutObjectTaggingInput.TagsEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
PutObjectTaggingOutput
+PutObjectTaggingOutput
+ + +| Field | Type | Label | Description |
| version_id | +string | ++ | The versionId of the object the tag-set was added to. |
+
| result_metadata | +PutObjectTaggingOutput.ResultMetadataEntry | +repeated | +Metadata pertaining to the operation's result. |
+
PutObjectTaggingOutput.ResultMetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
RestoreObjectInput
+RestoreObjectInput
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of oss store. |
+
| bucket | +string | ++ | The bucket name containing the object +This member is required |
+
| key | +string | ++ | Name of the object key. +This member is required. |
+
| restore_request | +RestoreRequest | ++ | The information of restoring request. |
+
| version_id | +string | ++ | VersionId used to reference a specific version of the object. |
+
RestoreObjectOutput
+RestoreObjectOutput
+ + +| Field | Type | Label | Description |
| request_charged | +string | ++ | If present, indicates that the requester was successfully charged for the +request. |
+
| restore_output_path | +string | ++ | Indicates the path in the provided S3 output location where Select results will +be restored to. |
+
RestoreRequest
+RestoreRequest
+ + +| Field | Type | Label | Description |
| days | +int32 | ++ | Lifetime of the active copy in days. |
+
| description | +string | ++ | The optional description for the job. |
+
| glacier_job_parameters | +GlacierJobParameters | ++ | S3 Glacier related parameters pertaining to this job. |
+
| output_location | +OutputLocation | ++ | Describes the location where the restore job's output is stored. |
+
| select_parameters | +SelectParameters | ++ | Describes the parameters for Select job types. |
+
| tier | +string | ++ | Retrieval tier at which the restore will be processed. |
+
| type | +string | ++ | Type of restore request. |
+
SelectParameters
+SelectParameters
+ + +| Field | Type | Label | Description |
| expression | +string | ++ | The expression that is used to query the object. +This member is required. |
+
| expression_type | +string | ++ | The type of the provided expression (for example, SQL). +This member is required. |
+
| input_serialization | +InputSerialization | ++ | Describes the serialization format of the object. +This member is required. |
+
| output_serialization | +OutputSerialization | ++ | Describes how the results of the Select job are serialized. +This member is required. |
+
SignURLInput
+SignURLInput
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of oss store. |
+
| bucket | +string | ++ | The bucket name containing the object +This member is required |
+
| key | +string | ++ | Name of the object key. +This member is required. |
+
| method | +string | ++ | the method for sign url, eg. GET、POST |
+
| expired_in_sec | +int64 | ++ | expire time of the sign url |
+
SignURLOutput
+SignURLOutput
+ + +| Field | Type | Label | Description |
| signed_url | +string | ++ | Object signed url |
+
UpdateBandwidthRateLimitInput
+UpdateBandwidthRateLimitInput
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of oss store. |
+
| average_rate_limit_in_bits_per_sec | +int64 | ++ | The average upload/download bandwidth rate limit in bits per second. |
+
| gateway_resource_name | +string | ++ | Resource name of gateway |
+
UploadPartCopyInput
+UploadPartCopyInput
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of oss store. |
+
| bucket | +string | ++ | The bucket name containing the object +This member is required |
+
| key | +string | ++ | Name of the object key. +This member is required. |
+
| copy_source | +CopySource | ++ | CopySource |
+
| part_number | +int32 | ++ | Part number of part being copied. This is a positive integer between 1 and 10,000. +This member is required. |
+
| upload_id | +string | ++ | Upload ID identifying the multipart upload whose part is being copied. +This member is required. |
+
| start_position | +int64 | ++ | The range of bytes to copy from the source object.bytes=start_position-part_size |
+
| part_size | +int64 | ++ | Part size |
+
UploadPartCopyOutput
+UploadPartCopyOutput
+ + +| Field | Type | Label | Description |
| bucket_key_enabled | +bool | ++ | Indicates whether the multipart upload uses an S3 Bucket Key for server-side +encryption with Amazon Web Services KMS (SSE-KMS). |
+
| copy_part_result | +CopyPartResult | ++ | Container for all response elements. |
+
| copy_source_version_id | +string | ++ | The version of the source object that was copied, if you have enabled versioning +on the source bucket. |
+
| request_charged | +string | ++ | If present, indicates that the requester was successfully charged for the +request. |
+
| sse_customer_algorithm | +string | ++ | If server-side encryption with a customer-provided encryption key was requested, +the response will include this header confirming the encryption algorithm used. |
+
| sse_customer_key_md5 | +string | ++ | If server-side encryption with a customer-provided encryption key was requested, +the response will include this header to provide round-trip message integrity +verification of the customer-provided encryption key. |
+
| sse_kms_key_id | +string | ++ | If present, specifies the ID of the Amazon Web Services Key Management Service +(Amazon Web Services KMS) symmetric customer managed key that was used for the +object. |
+
| server_side_encryption | +string | ++ | The server-side encryption algorithm used when storing this object in Amazon S3 +(for example, AES256, aws:kms). |
+
UploadPartInput
+UploadPartInput
+ + +| Field | Type | Label | Description |
| store_name | +string | ++ | Required. The name of oss store. |
+
| bucket | +string | ++ | The bucket name containing the object +This member is required |
+
| key | +string | ++ | Name of the object key. +This member is required. |
+
| body | +bytes | ++ | Object data. |
+
| content_length | +int64 | ++ | Size of the body in bytes. This parameter is useful when the size of the body +cannot be determined automatically. |
+
| content_md5 | +string | ++ | The base64-encoded 128-bit MD5 digest of the part data. |
+
| expected_bucket_owner | +string | ++ | The account ID of the expected bucket owner |
+
| part_number | +int32 | ++ | Part number of part being uploaded. This is a positive integer between 1 and 10,000. +This member is required. |
+
| request_payer | +string | ++ | Confirms that the requester knows that they will be charged for the request. |
+
| sse_customer_algorithm | +string | ++ | Specifies the algorithm to use to when encrypting the object (for example, +AES256). |
+
| sse_customer_key | +string | ++ | Specifies the customer-provided encryption key for Amazon S3 to use in +encrypting data |
+
| sse_customer_key_md5 | +string | ++ | Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. |
+
| upload_id | +string | ++ | Upload ID identifying the multipart upload whose part is being uploaded. +This member is required. |
+
UploadPartOutput
+UploadPartOutput
+ + +| Field | Type | Label | Description |
| bucket_key_enabled | +bool | ++ | Indicates whether the multipart upload uses an S3 Bucket Key for server-side +encryption with Amazon Web Services KMS (SSE-KMS). |
+
| etag | +string | ++ | Entity tag for the uploaded object. |
+
| request_charged | +string | ++ | If present, indicates that the requester was successfully charged for the +request. |
+
| sse_customer_algorithm | +string | ++ | Specifies the algorithm to use to when encrypting the object (for example, +AES256). |
+
| sse_customer_key_md5 | +string | ++ | Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. |
+
| sse_kms_key_id | +string | ++ | Specifies the ID of the symmetric customer managed key to use for object encryption |
+
| server_side_encryption | +string | ++ | The server-side encryption algorithm used when storing this object in Amazon S3 +(for example, AES256, aws:kms). |
+
Protocol Documentation
+ +Table of Contents
+ +
+
+
+
+
+ -
+
+
+
-
+ sms.proto
+
-
+
+
+
- + SSmsService + + +
+
+
+
+
+
+
+
+ sms.proto
Top +[gRPC Service] SmsService
+SmsService is used to send SMS messages.
+| Method Name | Request Type | Response Type | Description |
| SendSmsWithTemplate | +SendSmsWithTemplateRequest | +SendSmsWithTemplateResponse | +Send the SMS message. |
+
SendSmsWithTemplateRequest
+SendSmsRequest is the request of the `SendSms` method.
+ + +| Field | Type | Label | Description |
| component_name | +string | ++ | Required. The saas service name + If your system uses multiple SMS services at the same time, + you can specify which service to use with this field. |
+
| phone_numbers | +string | +repeated | +Required. The SMS receive phone numbers. |
+
| template | +Template | ++ | Required. |
+
| sign_name | +string | ++ | The registered sign name |
+
| sender_id | +string | ++ | The SMS sender tag. |
+
| metadata | +SendSmsWithTemplateRequest.MetadataEntry | +repeated | +The metadata which will be sent to SMS components. |
+
SendSmsWithTemplateRequest.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
SendSmsWithTemplateResponse
+SendSmsResponse is the response of the `SendSms` method.
+ + +| Field | Type | Label | Description |
| request_id | +string | ++ | The unique requestId. |
+
| results | +SendStatus | +repeated | +The status set of SMS |
+
SendStatus
+Status contains more information about the response
+ + +| Field | Type | Label | Description |
| code | +string | ++ | "OK" represents success. |
+
| message | +string | ++ | The error message. |
+
| metadata | +SendStatus.MetadataEntry | +repeated | +The send status metadata returned from SMS service. +Includes `PhoneNumber`. +`PhoneNumber`, is the phone number SMS send to. Supported by tencentcloud. |
+
SendStatus.MetadataEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
Template
+Sms template
+ + +| Field | Type | Label | Description |
| template_id | +string | ++ | Required |
+
| template_params | +Template.TemplateParamsEntry | +repeated | +Required |
+
Template.TemplateParamsEntry
+ + + +| Field | Type | Label | Description |
| key | +string | ++ |
|
+
| value | +string | ++ |
|
+
-
-[//]: # ([](https://github.com/mosn/layotto/actions/workflows/quickstart-checker.yml))
-[](https://github.com/mosn/layotto/actions/workflows/proto-checker.yml)
-[](https://github.com/mosn/layotto/actions/workflows/layotto-ci.yml)
-
-[](https://godoc.org/mosn.io/layotto)
-[](https://goreportcard.com/report/mosn.io/layotto)
-[](https://codecov.io/gh/mosn/layotto)
-[](http://isitmaintained.com/project/mosn/layotto "Average time to resolve an issue")
-
-
-
-Layotto(/leɪˈɒtəʊ/) 是一款使用 Golang 开发的应用运行时, 旨在帮助开发人员快速构建云原生应用，帮助应用和基础设施解耦。它为应用提供了各种分布式能力，比如状态管理，配置管理，事件发布订阅等能力，以简化应用的开发。
-
-Layotto 以开源的 [MOSN](https://github.com/mosn/mosn) 为底座，在提供分布式能力以外，提供了 Service Mesh 对于流量的管控能力。
-
-## 诞生背景
-
-Layotto 希望可以把 [Multi-Runtime](https://www.infoq.com/articles/multi-runtime-microservice-architecture/) 跟 Service
-Mesh 两者的能力结合起来，无论你是使用 MOSN 还是 Envoy 或者其他产品作为 Service Mesh 的数据面，都可以在不增加新的 sidecar 的前提下，使用 Layotto 为这些数据面追加 Runtime 的能力。
-
-例如，通过为 MOSN 添加 Runtime 能力，一个 Layotto 进程可以[既作为 istio 的数据面](/docs/start/istio/start.md) 又提供各种 Runtime API（例如 Configuration API,Pub/Sub API 等）
-
-此外，随着探索实践，我们发现 sidecar 能做的事情远不止于此。 通过引入[WebAssembly](https://en.wikipedia.org/wiki/WebAssembly) ,我们正在尝试将 Layotto 做成 FaaS (Function as a service) 的运行时容器 。
-
-如果您对诞生背景感兴趣，可以看下[这篇演讲](https://mosn.io/layotto/#/zh/blog/mosn-subproject-layotto-opening-a-new-chapter-in-service-grid-application-runtime/index)
-。
-
-## 功能
-
-- 服务通信
-- 服务治理，例如流量的劫持和观测，服务限流等
-- [作为 istio 的数据面](/docs/start/istio/start.md)
-- 配置管理
-- 状态管理
-- 事件发布订阅
-- 健康检查、查询运行时元数据
-- 基于 WASM 的多语言编程
-
-## 工程架构
-
-如下图架构图所示，Layotto 以开源 MOSN 作为底座，在提供了网络层管理能力的同时提供了分布式能力，业务可以通过轻量级的 SDK 直接与 Layotto 进行交互，而无需关注后端的具体的基础设施。
-
-Layotto 提供了多种语言版本的 SDK，SDK 通过 gRPC 与 Layotto 进行交互。
-
-如果您想把应用部署到不同的云平台（例如将阿里云上的应用部署到 AWS），您只需要在 Layotto 提供的 [配置文件](https://github.com/mosn/layotto/blob/main/configs/runtime_config.json)
-里修改配置、指定自己想用的基础设施类型，不需要修改应用的代码就能让应用拥有"跨云部署"能力，大大提高了程序的可移植性。
-
-
-
-## 快速开始
-
-### Get started with Layotto
-
-您可以尝试以下 Quickstart demo，体验 Layotto 的功能；或者体验[线上实验室](/docs/start/lab.md)
-
-### API
-
-| API | status | quick start | desc |
-| -------------- | :----: | :-------------------------------------------------------------------: | -------------------------------- |
-| State | ✅ | [demo](https://mosn.io/layotto/#/zh/start/state/start) | 提供读写 KV 模型存储的数据的能力 |
-| Pub/Sub | ✅ | [demo](https://mosn.io/layotto/#/zh/start/pubsub/start) | 提供消息的发布/订阅能力 |
-| Service Invoke | ✅ | [demo](https://mosn.io/layotto/#/zh/start/rpc/helloworld) | 通过 MOSN 进行服务调用 |
-| Config | ✅ | [demo](https://mosn.io/layotto/#/zh/start/configuration/start-apollo) | 提供配置增删改查及订阅的能力 |
-| Lock | ✅ | [demo](https://mosn.io/layotto/#/zh/start/lock/start) | 提供 lock/unlock 分布式锁的实现 |
-| Sequencer | ✅ | [demo](https://mosn.io/layotto/#/zh/start/sequencer/start) | 提供获取分布式自增 ID 的能力 |
-| File | ✅ | [demo](https://mosn.io/layotto/#/zh/start/file/start) | 提供访问文件的能力 |
-| Binding | ✅ | TODO | 提供透传数据的能力 |
-
-### Service Mesh
-
-| feature | status | quick start | desc |
-| ------- | :----: | :----------------------------------------------------: | ----------------------------- |
-| Istio | ✅ | [demo](https://mosn.io/layotto/#/zh/start/istio/) | 跟 Istio 集成，作为 Istio 的数据面 |
-
-### 可扩展性
-
-| feature | status | quick start | desc |
-| -------- | :----: | :--------------------------------------------------------------: | --------------------------- |
-| API 插件 | ✅ | [demo](https://mosn.io/layotto/#/zh/start/api_plugin/helloworld) | 为 Layotto 添加您自己的 API |
-
-### 可观测性
-
-
-| feature | status | quick start | desc |
-| ---------- | :----: | :---------------------------------------------------------: | ----------------------- |
-| Skywalking | ✅ | [demo](https://mosn.io/layotto/#/zh/start/trace/skywalking) | Layotto 接入 Skywalking |
-
-
-### Actuator
-
-| feature | status | quick start | desc |
-| -------------- | :----: | :-------------------------------------------------------: | ------------------------------------- |
-| Health Check | ✅ | [demo](https://mosn.io/layotto/#/zh/start/actuator/start) | 查询 Layotto 依赖的各种组件的健康状态 |
-| Metadata Query | ✅ | [demo](https://mosn.io/layotto/#/zh/start/actuator/start) | 查询 Layotto 或应用对外暴露的元信息 |
-
-### 流量控制
-
-| feature | status | quick start | desc |
-| ------------ | :----: | :-------------------------------------------------------------------: | ------------------------------------------ |
-| TCP Copy | ✅ | [demo](https://mosn.io/layotto/#/zh/start/network_filter/tcpcopy) | 把 Layotto 收到的 TCP 数据 dump 到本地文件 |
-| Flow Control | ✅ | [demo](https://mosn.io/layotto/#/zh/start/stream_filter/flow_control) | 限制访问 Layotto 对外提供的 API |
-
-### 在 Sidecar 中用 WebAssembly (WASM) 写业务逻辑
-
-| feature | status | quick start | desc |
-| -------------- | :----: | :---------------------------------------------------: | ---------------------------------------------------------------- |
-| Go (TinyGo) | ✅ | [demo](https://mosn.io/layotto/#/zh/start/wasm/start) | 把用 TinyGo 开发的代码编译成 \*.wasm 文件跑在 Layotto 上 |
-| Rust | ✅ | [demo](https://mosn.io/layotto/#/zh/start/wasm/start) | 把用 Rust 开发的代码编译成 \*.wasm 文件跑在 Layotto 上 |
-| AssemblyScript | ✅ | [demo](https://mosn.io/layotto/#/zh/start/wasm/start) | 把用 AssemblyScript 开发的代码编译成 \*.wasm 文件跑在 Layotto 上 |
-
-### 作为 Serverless 的运行时，通过 WebAssembly (WASM) 写 FaaS
-
-| feature | status | quick start | desc |
-| -------------- | :----: | :---------------------------------------------------: | ----------------------------------------------------------------------------------------- |
-| Go (TinyGo) | ✅ | [demo](https://mosn.io/layotto/#/zh/start/faas/start) | 把用 TinyGo 开发的代码编译成 \*.wasm 文件跑在 Layotto 上，并且使用 k8s 进行调度。 |
-| Rust | ✅ | [demo](https://mosn.io/layotto/#/zh/start/faas/start) | 把用 Rust 开发的代码编译成 \*.wasm 文件跑在 Layotto 上，并且使用 k8s 进行调度。 |
-| AssemblyScript | ✅ | [demo](https://mosn.io/layotto/#/zh/start/faas/start) | 把用 AssemblyScript 开发的代码编译成 \*.wasm 文件跑在 Layotto 上，并且使用 k8s 进行调度。 |
-
-## Landscapes
-
-
-
-
-Layotto enriches the CNCF CLOUD NATIVE Landscape.
-
|
-| 💬 [钉钉](https://www.dingtalk.com/zh) (社区会议群) | 群号：41585216 [Layotto 在每周五晚 8 点进行社区会议，欢迎所有人](/docs/community/meeting.md) |
-
-[comment]: <> (| 💬 [微信](https://www.wechat.com/) | 扫描下方二维码添加好友，她会邀请您加入微信群 
)
-
-## 如何贡献
-
-[新手攻略：从零开始成为 Layotto 贡献者](/docs/development/start-from-zero.md)
-
-[从哪下手？看看"新手任务"列表](https://github.com/mosn/layotto/issues/108#issuecomment-872779356)
-
-作为技术同学，你是否有过“想参与某个开源项目的开发、但是不知道从何下手”的感觉？
-为了帮助大家更好的参与开源项目，社区会定期发布适合新手的新手开发任务，帮助大家 learning by doing!
-
-[文档贡献指南](/docs/development/contributing-doc.md)
-
-[组件开发指南](/docs/development/developing-component.md)
-
-[Layotto Github Workflow 指南](/docs/development/github-workflows.md)
-
-[Layotto 命令行指南](/docs/development/commands.md)
-
-[Layotto 贡献者指南](/docs/development/CONTRIBUTING.md)
-
-## 贡献者
-
-感谢所有的贡献者！
-
-
-
+
-# Layotto (L8): To be the next layer of OSI layer 7
-
-
-[](https://github.com/mosn/layotto/actions/workflows/proto-checker.yml)
+[](https://github.com/mosn/layotto/actions/workflows/quickstart-checker.yml)
[](https://github.com/mosn/layotto/actions/workflows/layotto-ci.yml)
[](https://godoc.org/mosn.io/layotto)
@@ -10,6 +10,7 @@
[](https://codecov.io/gh/mosn/layotto)
[](http://isitmaintained.com/project/mosn/layotto "Average time to resolve an issue")
+
Layotto(/leɪˈɒtəʊ/) is an application runtime developed using Golang, which provides various distributed capabilities for applications, such as state management, configuration management, and event pub/sub capabilities to simplify application development.
@@ -19,7 +20,7 @@ Layotto is built on the open source data plane [MOSN](https://github.com/mosn/mo
Layotto aims to combine [Multi-Runtime](https://www.infoq.com/articles/multi-runtime-microservice-architecture/) with Service Mesh into one sidecar. No matter which product you are using as the Service Mesh data plane (e.g. MOSN,Envoy or any other product), you can always attach Layotto to it and add Multi-Runtime capabilities without adding new sidecars.
-For example, by adding Runtime capabilities to MOSN, a Layotto process can both [serve as the data plane of istio](/docs/start/istio/) and provide various Runtime APIs (such as Configuration API, Pub/Sub API, etc.)
+For example, by adding Runtime capabilities to MOSN, a Layotto process can both [serve as the data plane of istio](en/start/istio/) and provide various Runtime APIs (such as Configuration API, Pub/Sub API, etc.)
In addition, we were surprised to find that a sidecar can do much more than that. We are trying to make Layotto even the runtime container of FaaS (Function as a service) with the magic power of [WebAssembly](https://en.wikipedia.org/wiki/WebAssembly) .
@@ -27,7 +28,7 @@ In addition, we were surprised to find that a sidecar can do much more than that
- Service Communication
- Service Governance.Such as traffic hijacking and observation, service rate limiting, etc
-- [As the data plane of istio](/docs/tart/istio/)
+- [As the data plane of istio](en/start/istio/)
- Configuration management
- State management
- Event publish and subscribe
@@ -46,7 +47,7 @@ Layotto provides sdk in various languages. The sdk interacts with Layotto throug
### Get started with Layotto
-You can try the quickstart demos below to get started with Layotto. In addition, you can experience the [online laboratory](/docs/start/lab)
+You can try the quickstart demos below to get started with Layotto. In addition, you can experience the [online laboratory](en/start/lab)
### API
@@ -66,7 +67,7 @@ You can try the quickstart demos below to get started with Layotto. In addition,
| feature | status | quick start | desc |
| ------- | :----: | :----------------------------------------------------: | -------------------------- |
-| istio | ✅ | [demo](/docs/start/istio/) | As the data plane of istio |
+| istio | ✅ | [demo](en/start/istio/) | As the data plane of istio |
### Extendability
@@ -121,9 +122,9 @@ Layotto enriches the CNCF CLOUD N
### Contact Us
-| Platform | Link |
-| :----------------------------------------------------- |:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| 💬 [DingTalk](https://www.dingtalk.com/en) (preferred) | Search the group number: 31912621 or scan the QR code below Layotto (L8): To be the next layer of OSI layer 7
+
-# Layotto (L8): To be the next layer of OSI layer 7
-
-
-[](https://github.com/mosn/layotto/actions/workflows/proto-checker.yml)
+[](https://github.com/mosn/layotto/actions/workflows/quickstart-checker.yml)
[](https://github.com/mosn/layotto/actions/workflows/layotto-ci.yml)
[](https://godoc.org/mosn.io/layotto)
@@ -10,6 +10,7 @@
[](https://codecov.io/gh/mosn/layotto)
[](http://isitmaintained.com/project/mosn/layotto "Average time to resolve an issue")
+
|
+| Platform | Link |
+| :----------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| 💬 [DingTalk](https://www.dingtalk.com/en) (preferred) | Search the group number: 31912621 or scan the QR code below |
[comment]: <> (| 💬 [Wechat](https://www.wechat.com/en/) | Scan the QR code below and she will invite you into the wechat group 
)
@@ -134,15 +135,15 @@ Layotto enriches the CNCF CLOUD N
As a programming enthusiast , have you ever felt that you want to participate in the development of an open source project, but don't know where to start?
In order to help everyone better participate in open source projects, our community will regularly publish community tasks to help everyone learn by doing!
-[Document Contribution Guide](/docs/development/contributing-doc)
+[Document Contribution Guide](en/development/contributing-doc.md)
-[Component Development Guide](/docs/development/developing-component)
+[Component Development Guide](en/development/developing-component.md)
-[Layotto Github Workflows](/docs/development/github-workflows)
+[Layotto Github Workflows](en/development/github-workflows.md)
-[Layotto Commands Guide](/docs/development/commands)
+[Layotto Commands Guide](en/development/commands.md)
-[Layotto contributor guide](/docs/development/CONTRIBUTING)
+[Layotto contributor guide](en/development/CONTRIBUTING.md)
## Contributors
@@ -154,17 +155,17 @@ Thank y'all!
## Design Documents
-[Actuator Design Doc](/docs/design/actuator/actuator-design-doc)
+[Actuator Design Doc](en/design/actuator/actuator-design-doc.md)
-[Configuration API with Apollo](/docs/design/configuration/configuration-api-with-apollo)
+[Configuration API with Apollo](en/design/configuration/configuration-api-with-apollo.md)
-[Pubsub API and Compability with Dapr Component](/docs/design/pubsub/pubsub-api-and-compability-with-dapr-component)
+[Pubsub API and Compability with Dapr Component](en/design/pubsub/pubsub-api-and-compability-with-dapr-component.md)
-[RPC Design Doc](/docs/design/rpc/rpc_design_document)
+[RPC Design Doc](en/design/rpc/rpc-design-doc.md)
-[Distributed Lock API Design](/docs/design/lock/lock-api-design)
+[Distributed Lock API Design](en/design/lock/lock-api-design.md)
-[FaaS Design](/docs/design/faas/faas-poc-design)
+[FaaS Design](en/design/faas/faas-poc-design.md)
## FAQ
diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/api_reference/README.md b/docs/en/api_reference/README.md
similarity index 100%
rename from docs/i18n/en-US/docusaurus-plugin-content-docs/current/api_reference/README.md
rename to docs/en/api_reference/README.md
diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/api_reference/appcallback_v1.md b/docs/en/api_reference/appcallback_v1.md
similarity index 99%
rename from docs/i18n/en-US/docusaurus-plugin-content-docs/current/api_reference/appcallback_v1.md
rename to docs/en/api_reference/appcallback_v1.md
index f072783564..54894d7c90 100644
--- a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/api_reference/appcallback_v1.md
+++ b/docs/en/api_reference/appcallback_v1.md
@@ -1,4 +1,7 @@
+
+
+
# appcallback.proto
diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/api_reference/comment_spec_of_proto.md b/docs/en/api_reference/comment_spec_of_proto.md
similarity index 100%
rename from docs/i18n/en-US/docusaurus-plugin-content-docs/current/api_reference/comment_spec_of_proto.md
rename to docs/en/api_reference/comment_spec_of_proto.md
diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/api_reference/how_to_generate_api_doc.md b/docs/en/api_reference/how_to_generate_api_doc.md
similarity index 100%
rename from docs/i18n/en-US/docusaurus-plugin-content-docs/current/api_reference/how_to_generate_api_doc.md
rename to docs/en/api_reference/how_to_generate_api_doc.md
diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/api_reference/oss_v1.md b/docs/en/api_reference/oss_v1.md
similarity index 99%
rename from docs/i18n/en-US/docusaurus-plugin-content-docs/current/api_reference/oss_v1.md
rename to docs/en/api_reference/oss_v1.md
index 5e4ae4206c..98da1ebce9 100644
--- a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/api_reference/oss_v1.md
+++ b/docs/en/api_reference/oss_v1.md
@@ -1,4 +1,7 @@
+
+
+
# oss.proto
diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/api_reference/runtime_v1.md b/docs/en/api_reference/runtime_v1.md
similarity index 99%
rename from docs/i18n/en-US/docusaurus-plugin-content-docs/current/api_reference/runtime_v1.md
rename to docs/en/api_reference/runtime_v1.md
index e481cac24b..787e1605e3 100644
--- a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/api_reference/runtime_v1.md
+++ b/docs/en/api_reference/runtime_v1.md
@@ -1,4 +1,7 @@
+
+
+
# runtime.proto
diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/building_blocks/actuator/actuator.md b/docs/en/building_blocks/actuator/actuator.md
similarity index 89%
rename from docs/i18n/en-US/docusaurus-plugin-content-docs/current/building_blocks/actuator/actuator.md
rename to docs/en/building_blocks/actuator/actuator.md
index 719e8fab81..3ebb8f2918 100644
--- a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/building_blocks/actuator/actuator.md
+++ b/docs/en/building_blocks/actuator/actuator.md
@@ -49,7 +49,7 @@ var (
)
```
-Note: By default, the API will only return the health status of Layotto. If you want the API to also return the health status of the App, you need to develop a plugin that calls back the App. You can refer to [Actuator's design document](design/actuator/actuator-design-doc.md), or contact us directly to provide you with a detailed explanation.
+Note: By default, the API will only return the health status of Layotto. If you want the API to also return the health status of the App, you need to develop a plugin that calls back the App. You can refer to [Actuator's design document](en/design/actuator/actuator-design-doc.md), or contact us directly to provide you with a detailed explanation.
### /actuator/health/readiness
Used to check the health status of Layotto and app. The health status can be used to determine "Do we need to temporarily cut off the traffic and make sure no user visit this machine"
@@ -75,7 +75,7 @@ GET,no parameters.
}
```
-Note: By default, the API will only return the health status of Layotto. If you want the API to also return the health status of the App, you need to develop a plugin that calls back the App. You can refer to [Actuator's design document](design/actuator/actuator-design-doc.md), or contact us directly to provide you with a detailed explanation.
+Note: By default, the API will only return the health status of Layotto. If you want the API to also return the health status of the App, you need to develop a plugin that calls back the App. You can refer to [Actuator's design document](en/design/actuator/actuator-design-doc.md), or contact us directly to provide you with a detailed explanation.
## 2. Query runtime metadata API
@@ -107,7 +107,7 @@ We can add more information in the future:
Actuator adopts a plug-in architecture, you can also add your own plug-ins as needed, and let the API return the runtime metadata you care about.
-Note: By default, the API will only return Layotto's runtime metadata. If you want the API to also return the App's runtime metadata, you need to develop a plugin that calls back the App. You can refer to [Actuator's design document](design/actuator/actuator-design-doc.md), or contact us directly to provide you with a detailed explanation.
+Note: By default, the API will only return Layotto's runtime metadata. If you want the API to also return the App's runtime metadata, you need to develop a plugin that calls back the App. You can refer to [Actuator's design document](en/design/actuator/actuator-design-doc.md), or contact us directly to provide you with a detailed explanation.
## 3. Explanation for API path
@@ -139,4 +139,4 @@ The paths registered by default are:
```
## 4. API usage example
-See [Quick start document](start/actuator/start.md)
\ No newline at end of file
+See [Quick start document](en/start/actuator/start.md)
\ No newline at end of file
diff --git a/docs/docs/building_blocks/configuration/reference.md b/docs/en/building_blocks/configuration/reference.md
similarity index 100%
rename from docs/docs/building_blocks/configuration/reference.md
rename to docs/en/building_blocks/configuration/reference.md
diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/building_blocks/file/file.md b/docs/en/building_blocks/file/file.md
similarity index 98%
rename from docs/i18n/en-US/docusaurus-plugin-content-docs/current/building_blocks/file/file.md
rename to docs/en/building_blocks/file/file.md
index ec14296c73..6bc4f676dd 100644
--- a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/building_blocks/file/file.md
+++ b/docs/en/building_blocks/file/file.md
@@ -7,7 +7,7 @@ File api is used to implement file operations. Applications can perform CRUD ope
## How to use File API
You can call the File API through grpc. The API is defined in [runtime.proto](https://github.com/mosn/layotto/blob/main/spec/proto/runtime/v1/runtime.proto).
-The component needs to be configured before use. Different components should have own configuration.For OSS detail configuration items, see [OSS Component Document](component_specs/file/oss.md)
+The component needs to be configured before use. Different components should have own configuration.For OSS detail configuration items, see [OSS Component Document](en/component_specs/file/oss.md)
### Example
diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/building_blocks/lock/reference.md b/docs/en/building_blocks/lock/reference.md
similarity index 96%
rename from docs/i18n/en-US/docusaurus-plugin-content-docs/current/building_blocks/lock/reference.md
rename to docs/en/building_blocks/lock/reference.md
index eb33755df8..39b14a6301 100644
--- a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/building_blocks/lock/reference.md
+++ b/docs/en/building_blocks/lock/reference.md
@@ -5,10 +5,10 @@ The distributed lock API is based on a certain storage system (such as Etcd, Zoo
## How to use distributed lock API
You can call the distributed lock API through grpc. The API is defined in [runtime.proto](https://github.com/mosn/layotto/blob/main/spec/proto/runtime/v1/runtime.proto).
-The component needs to be configured before use. For detailed configuration instructions, see [Distributed Lock Component Document](component_specs/lock/common.md)
+The component needs to be configured before use. For detailed configuration instructions, see [Distributed Lock Component Document](en/component_specs/lock/common.md)
### Example
-Layotto client sdk encapsulates the logic of grpc calling. For an example of using sdk to call distributed lock API, please refer to [Quick Start: Using Distributed Lock API](start/lock/start.md)
+Layotto client sdk encapsulates the logic of grpc calling. For an example of using sdk to call distributed lock API, please refer to [Quick Start: Using Distributed Lock API](en/start/lock/start.md)
### TryLock
@@ -76,4 +76,4 @@ req.LockOwner = uuid.New().String()
To avoid inconsistencies between the documentation and the code, please refer to [proto file](https://github.com/mosn/layotto/blob/main/spec/proto/runtime/v1/runtime.proto) for detailed input parameters and return values
## Why is the distributed lock API designed like this
-If you are interested in the implementation principle and design logic, you can refer to [Distributed Lock API Design Document](design/lock/lock-api-design)
+If you are interested in the implementation principle and design logic, you can refer to [Distributed Lock API Design Document](en/design/lock/lock-api-design)
diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/building_blocks/pubsub/reference.md b/docs/en/building_blocks/pubsub/reference.md
similarity index 97%
rename from docs/i18n/en-US/docusaurus-plugin-content-docs/current/building_blocks/pubsub/reference.md
rename to docs/en/building_blocks/pubsub/reference.md
index 3845bc2802..f37b18ccd5 100644
--- a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/building_blocks/pubsub/reference.md
+++ b/docs/en/building_blocks/pubsub/reference.md
@@ -19,10 +19,10 @@ Using Pub/Sub API can help you avoid the trouble of maintaining multilingual SDK
## How to use Pub/Sub API
You can call Pub/Sub API through grpc. The API is defined in [runtime.proto](https://github.com/mosn/layotto/blob/main/spec/proto/runtime/v1/runtime.proto).
-The component needs to be configured before use. For detailed configuration instructions, see [publish/subscribe component documentation](component_specs/pubsub/common.md)
+The component needs to be configured before use. For detailed configuration instructions, see [publish/subscribe component documentation](zh/component_specs/pubsub/common.md)
### Example
-Layotto client sdk encapsulates the logic of grpc call. For examples of using sdk to call Pub/Sub API, please refer to [Quick Start: Use Pub/Sub API](start/pubsub/start.md)
+Layotto client sdk encapsulates the logic of grpc call. For examples of using sdk to call Pub/Sub API, please refer to [Quick Start: Use Pub/Sub API](en/start/pubsub/start.md)
### PublishEvent
Used to publish events to the specified topic
diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/building_blocks/rpc/reference.md b/docs/en/building_blocks/rpc/reference.md
similarity index 100%
rename from docs/i18n/en-US/docusaurus-plugin-content-docs/current/building_blocks/rpc/reference.md
rename to docs/en/building_blocks/rpc/reference.md
diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/building_blocks/sequencer/reference.md b/docs/en/building_blocks/sequencer/reference.md
similarity index 96%
rename from docs/i18n/en-US/docusaurus-plugin-content-docs/current/building_blocks/sequencer/reference.md
rename to docs/en/building_blocks/sequencer/reference.md
index ed61f35857..1a1d342022 100644
--- a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/building_blocks/sequencer/reference.md
+++ b/docs/en/building_blocks/sequencer/reference.md
@@ -38,9 +38,9 @@ When you want the generated id incremental without any regression, it is recomme
## How to use Sequencer API
You can call the Sequencer API through grpc. The API is defined in [runtime.proto](https://github.com/mosn/layotto/blob/main/spec/proto/runtime/v1/runtime.proto).
-Layotto client sdk encapsulates the logic of grpc calling. For an example of using sdk to call Sequencer API, please refer to [Quick Start: Use Sequencer API](start/sequencer/start.md)
+Layotto client sdk encapsulates the logic of grpc calling. For an example of using sdk to call Sequencer API, please refer to [Quick Start: Use Sequencer API](en/start/sequencer/start.md)
-The components need to be configured before use. For detailed configuration options, see [Sequencer component document](component_specs/sequencer/common.md)
+The components need to be configured before use. For detailed configuration options, see [Sequencer component document](en/component_specs/sequencer/common.md)
### Get next unique id
```protobuf
diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/building_blocks/state/reference.md b/docs/en/building_blocks/state/reference.md
similarity index 98%
rename from docs/i18n/en-US/docusaurus-plugin-content-docs/current/building_blocks/state/reference.md
rename to docs/en/building_blocks/state/reference.md
index ce12fc8275..e92c9ac80c 100644
--- a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/building_blocks/state/reference.md
+++ b/docs/en/building_blocks/state/reference.md
@@ -20,10 +20,10 @@ Using State API can help you avoid the trouble of maintaining multilingual SDKs.
## How to use State API
You can call the State API through grpc. The API is defined in [runtime.proto](https://github.com/mosn/layotto/blob/main/spec/proto/runtime/v1/runtime.proto).
-The component needs to be configured before use. For detailed configuration items, see [State Component Document](component_specs/state/common.md)
+The component needs to be configured before use. For detailed configuration items, see [State Component Document](en/component_specs/state/common.md)
### Example
-Layotto client sdk encapsulates the logic of grpc call. For examples of using sdk to call State API, please refer to [Quick Start: Use State API](start/state/start.md)
+Layotto client sdk encapsulates the logic of grpc call. For examples of using sdk to call State API, please refer to [Quick Start: Use State API](en/start/state/start.md)
### Save state
diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/component_specs/configuration/apollo.md b/docs/en/component_specs/configuration/apollo.md
similarity index 96%
rename from docs/i18n/en-US/docusaurus-plugin-content-docs/current/component_specs/configuration/apollo.md
rename to docs/en/component_specs/configuration/apollo.md
index bbe0556dc5..2e8b223476 100644
--- a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/component_specs/configuration/apollo.md
+++ b/docs/en/component_specs/configuration/apollo.md
@@ -2,7 +2,7 @@
## Configuration item description
Example: configs/config_apollo.json
-
+
| Field | Required | Description |
| --- | --- | --- |
diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/component_specs/configuration/etcd.md b/docs/en/component_specs/configuration/etcd.md
similarity index 100%
rename from docs/i18n/en-US/docusaurus-plugin-content-docs/current/component_specs/configuration/etcd.md
rename to docs/en/component_specs/configuration/etcd.md
diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/component_specs/configuration/nacos.md b/docs/en/component_specs/configuration/nacos.md
similarity index 90%
rename from docs/i18n/en-US/docusaurus-plugin-content-docs/current/component_specs/configuration/nacos.md
rename to docs/en/component_specs/configuration/nacos.md
index d280e210e3..9bf87427c4 100644
--- a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/component_specs/configuration/nacos.md
+++ b/docs/en/component_specs/configuration/nacos.md
@@ -6,7 +6,7 @@ Example: configs/config_nacos.json
| Field | Required | Description |
|-----------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------|
-| address | Y | Nacos server address in `value,_ := client.Get("key") | +| SaveConfiguration | use open API via http. [update](https://www.apolloconfig.com/#/zh/usage/apollo-open-api-platform?id=_3211-%e4%bf%ae%e6%94%b9%e9%85%8d%e7%bd%ae%e6%8e%a5%e5%8f%a3) + [commit](https://www.apolloconfig.com/#/zh/usage/apollo-open-api-platform?id=_3213-%e5%8f%91%e5%b8%83%e9%85%8d%e7%bd%ae%e6%8e%a5%e5%8f%a3) | +| DeleteConfiguration | use open API via http. [delete](https://www.apolloconfig.com/#/zh/usage/apollo-open-api-platform?id=_3212-%e5%88%a0%e9%99%a4%e9%85%8d%e7%bd%ae%e6%8e%a5%e5%8f%a3) + [commit](https://www.apolloconfig.com/#/zh/usage/apollo-open-api-platform?id=_3213-%e5%8f%91%e5%b8%83%e9%85%8d%e7%bd%ae%e6%8e%a5%e5%8f%a3) | +| SubscribeConfiguration | https://github.com/apolloconfig/agollo/wiki/%E7%9B%91%E5%90%AC%E5%8F%98%E6%9B%B4%E4%BA%8B%E4%BB%B6 | + +### How to subscribe all config changes of the specified app + +Subscribe all namespaces declared in config.json \ No newline at end of file diff --git a/docs/en/design/faas/faas-poc-design.md b/docs/en/design/faas/faas-poc-design.md new file mode 100644 index 0000000000..b5bcd395b7 --- /dev/null +++ b/docs/en/design/faas/faas-poc-design.md @@ -0,0 +1,45 @@ +## FaaS design document + +### 1. Architecture + + + +In this FaaS solution, the following two problems are mainly solved: +1. What is the relationship between the compiled wasm file and the docker image? + 1. The target wasm file is finally built into an ordinary image and pushed to Dockerhub. The process of pulling the image is also consistent with the original image, but the target wasm file will be extracted from the image and loaded separately during actual operation. +2. How to make k8s manage and deploy wasm files? + 1. Incorporating into the k8s life cycle management and scheduling strategy, the Containerd-shim-layotto-v2 plugin implements the v2 interface definition of Containerd, and changes the container runtime to Layotto Runtime. For example, the implementation of k8s creating a container is modified to load and run functions in form of wasm. + 2. Thanks to the excellent sandbox isolation environment of WebAssembly, Layotto as a function base can load and run multiple wasm functions. Although they all run in the same process, they do not affect each other. Compared with docker, this idea of nanoprocess can make fuller use of resources. + +### 2. Core components + +#### A、Function + +The wasm1 and wasm2 in the above figure respectively represent two functions. After the function is developed, it will be compiled into the form of `*.wasm` and loaded and run. It makes full use of the sandbox isolation environment provided by [WebAssembly(wasm)](https://webassembly.org/) to avoid mutual influence between multiple functions. + +#### B、[Layotto](https://github.com/mosn/layotto) + +The goal is to provide services, resources, and safety for the function. As the base of function runtime, it provides functions including WebAssembly runtime, access to infrastructure, maximum resource limit for functions, and system call permission verification for functions. + +#### C、[Containerd](https://containerd.io/) + +Officially supported container runtime, docker is currently the most widely used implementation. In addition, secure containers such as kata and gvisor also use this technology. Layotto also refers to their implementation ideas and integrates the process of loading and running functions into the container runtime. + +#### D、[Containerd-shim-layotto-v2](https://github.com/layotto/containerd-wasm) + +Based on the V2 interface definition of Containerd, the runtime logic of the container is customized. For example, the implementation of creating a container is modified to let Layotto load and run the wasm function. + +#### E、[Kubernetes](https://kubernetes.io/) + +The current container scheduling standards, life cycle management and scheduling strategies are excellent. Layotto chose to use the containerd in order to perfectly integrate the scheduling of functions with the k8s ecology. + +### 3. Runtime ABI + +#### A. [proxy-wasm-go-sdk](https://github.com/layotto/proxy-wasm-go-sdk) + +On the basis of [proxy-wasm/spec](https://github.com/proxy-wasm/spec), refer to the definition of [Runtime API](https://github.com/mosn/layotto/blob/main/spec/proto/runtime/v1/runtime.proto), add APIs for functions to access infrastructure. + +#### B. [proxy-wasm-go-host](https://github.com/layotto/proxy-wasm-go-host) + +It is used to implement the logic of Runtime ABI in Layotto. + diff --git a/docs/en/design/lock/lock-api-design.md b/docs/en/design/lock/lock-api-design.md new file mode 100644 index 0000000000..4b08c2d0fa --- /dev/null +++ b/docs/en/design/lock/lock-api-design.md @@ -0,0 +1,258 @@ +# 0. tl;dl +This proposal try to add TryLock and Unlock API. + +The Lock Renewal API might be controversial and will not be added into the first version + +# 1. Why it is needed +Application developers need distributed locks to keep their data safe from race conditions,but implementing a distributed lock correctly is challenging,since you have to be careful to prevent deadlock or some incorrect corner cases from happening. + +An easy-to-use distributed lock API provided by runtime sidecar can be helpful. + + +# 2. Evaluation of products on the market +| **System** | **tryLock(non-blocking lock)** | **Blocking lock(based on watch)** | **Availability** | **Write operations are linearizable** | **sequencer([chubby's feature](https://static.googleusercontent.com/media/research.google.com/zh-TW//archive/chubby-osdi06.pdf))** | **Lock renewal** | +| --- | --- | --- | --- | --- | --- | --- | +| Stand-alone redis | yes | x | unavailable when single failure | yes | yes(need poc) | yes | +| redis cluster | yes | x | yes | no. Locks will be unsafe when fail-over happens | yes(need poc) | yes | +| redis Redlock | yes | | | | | | +| consul | yes | | | | | | +| zookeeper | yes | yes | yes. [the election completes within 200 ms](https://pdos.csail.mit.edu/6.824/papers/zookeeper.pdf) | yes | yes use zxid as sequencer | yes | +| etcd | yes | yes | yes | yes | yes use revision | yes lease.KeepAlive | + +There are some differences in feature supporting. + +# 2. High-level design +## 2.1. API +### 2.1.0. Design principles +We are faced with many temptations. In fact, there are many lock related features that can be supported (blocking locks, reentrant locks, read-write locks, sequencer, etc.) + +But after all, our goal is to design a general API specification, so we should be as conservative as possible in API definition.Start simple, abstract the simplest and most commonly used functions into API specifications, and wait for user feedback before considering adding more abstraction into API specification. + +### 2.1.1. TryLock/Unlock API +The most basic locking and unlocking API. + +TryLock is non-blocking, it return directly if the lock is not obtained. + +proto: + +```protobuf + // Distributed Lock API + // A non-blocking method trying to get a lock with ttl. + rpc TryLock(TryLockRequest)returns (TryLockResponse) {} + + rpc Unlock(UnlockRequest)returns (UnlockResponse) {} + + + +message TryLockRequest { + // Required. The lock store name,e.g. `redis`. + string store_name = 1; + + // Required. resource_id is the lock key. e.g. `order_id_111` + // It stands for "which resource I want to protect" + string resource_id = 2; + + // Required. lock_owner indicate the identifier of lock owner. + // You can generate a uuid as lock_owner.For example,in golang: + // + // req.LockOwner = uuid.New().String() + // + // This field is per request,not per process,so it is different for each request, + // which aims to prevent multi-thread in the same process trying the same lock concurrently. + // + // The reason why we don't make it automatically generated is: + // 1. If it is automatically generated,there must be a 'my_lock_owner_id' field in the response. + // This name is so weird that we think it is inappropriate to put it into the api spec + // 2. If we change the field 'my_lock_owner_id' in the response to 'lock_owner',which means the current lock owner of this lock, + // we find that in some lock services users can't get the current lock owner.Actually users don't need it at all. + // 3. When reentrant lock is needed,the existing lock_owner is required to identify client and check "whether this client can reenter this lock". + // So this field in the request shouldn't be removed. + string lock_owner = 3; + + // Required. expire is the time before expire.The time unit is second. + int32 expire = 4; +} + + +message TryLockResponse { + + bool success = 1; +} + +message UnlockRequest { + string store_name = 1; + // resource_id is the lock key. + string resource_id = 2; + + string lock_owner = 3; +} + +message UnlockResponse { + enum Status { + SUCCESS = 0; + LOCK_UNEXIST = 1; + LOCK_BELONG_TO_OTHERS = 2; + INTERNAL_ERROR = 3; + } + + Status status = 1; +} + +``` + +**Q: What is the time unit of the expire field?** + +A: Seconds. + +**Q: Can we force the user to set the number of seconds to be large enough(instead of too small)?** + +A: There is no way to limit it at compile time or startup, forget it + +**Q: What would happen if different applications pass the same lock_owner?** + +case 1. If two apps with different app-id pass the same lock_owner,they won't conflict because lock_owner is grouped by 'app-id ',while 'app-id' is configurated in sidecar's static config(configurated in config.json or passed as parameters at startup) + +case 2.If two apps with same app-id pass the same lock_owner,they will conflict and the second app will obtained the same lock already used by the first app.Then the correctness property will be broken. + +So user has to care about the uniqueness property of lock_owner. + +**Q: Why not add metadata field** + +A: Try to be conservative at the beginning, wait until someone feedbacks that there is a need, or find that there is a need to be added in the process of implementing the component + +**Q: How to add features such as sequencer and reentrant locks in the future?** + +A: Add feature options in the API parameters,and the component must also implement the Support() function + +### 2.1.2. Lock Renewal API +Renewal API aims to refresh the existing lock and postpone the expiration time. + +Lock Renewal API won't be in the first version of this API. Here are some considerations for discussion. + +#### Solution A: add an API "LockKeepAlive" +  + +```protobuf +rpc LockKeepAlive(stream LockKeepAliveRequest) returns (stream LockKeepAliveResponse){} + +message LockKeepAliveRequest { + // resource_id is the lock key. + string resource_id = 1; + + string lock_owner = 2; + // expire is the time to expire + int64 expire = 3; +} + +message LockKeepAliveResponse { + enum Status { + SUCCESS = 0; + LOCK_UNEXIST = 1; + LOCK_BELONG_TO_OTHERS = 2; + } + // resource_id is the lock key. + string resource_id = 1; + + Status status = 2; +} +``` + +Users have to start a thread or coroutine to periodically renew the lock. + +The input parameters and return results of this API are all streams. App and sidecar only need to maintain one connection. Each time the lock needs to be renewed, the connection is reused to transfer the renewal request. + +**Q: Why not put the lock renewal as a stream parameter into tryLock?** + +- Lock renewal is not a high frequency demand, so we want trylock to be as simple as possible; + +- Single responsibility principle.When we want to add a blocking lock,the renewal API can be reused; + +**Q: The renewal logic is too complicated, can we make it transparent to users?** + +A: sdk can do this logic for users.Sdk will start a thread,coroutine or nodejs timing event to automatically renew the lease + + +#### Solution B: Make users not aware of the renewal logic +Our sidecar can automatically renew the lease with heartbeat. App and sidecar maintain a heartbeat for failure detection. + + + +Disadvantages/difficulties: + +1. If we reuse a public heartbeat, it is difficult to customize the heartbeat interval + +An option is to ensure that the heartbeat interval low enough, such as 1 time per second + +2. How to ensure reliable failure detection? + +For example, the following java code `unlock()` method may fail: + +```java +try{ + +}finally{ + lock.unlock() +} +``` + +If it is a lock in JVM, unlock can guarantee success (unless the entire JVM fails), but unlock may fail if it is called via the network. How to ensure that the heartbeat is interrupted after the call fails? + +Here shows the corner case: + + + + + + +Solving this case requires the app to report some fine-grained status with the heartbeat. + +We can define a http callback SPI, which is polled and detected by the sidecar, and the data structure returned by the callback is as follows: + +```json +{ + "status": "UP", + "details": { + "lock": [ + { + "resource_id": "res1", + "lock_owner": "dasfdasfasdfa", + "type": "unlock_fail" + } + ], + "xxx": [] + } +} +``` + +The application has to handle status collection, reporting, cleaning up after the report is successful, and limiting the map capacity (for example, what if the map is too large when report fails too much times?), which requires the app to implement some complex logic, and it must be put in the SDK. + +3. This implementation is actually the same as Solution A. It opens a separate connection for status management and failure detection, and user reports the status through this public connection when necessary. + +4. Solution B actually make API spec rely on heartbeat logic. It relies on the heartbeat interval and the data structure returned by the heartbeat. It is equivalent to that the API spec relies on the implementation of sidecar, unless we can also standardize the heartbeat API (including interval, returned data structure, etc.) + +#### Conclusion +At present, the Lock Renewal API might be controversial and will not be added into the first version. + +Personally I prefer the solution A.Let the SDK do the renewal logic. Although users have to directly deal with the lease renewal logic when using grpc, it is not hard for developers to understand. + +I put it here to see your opinion. + +# 3. Future work + +- Reentrant Lock + +There will be some counting logic.We need to consider whether all locks support reentrancy by default, or add a feature option in the parameter to identify that the user needs it to be reentrant + +- Heartbeat API + +If we want to implement more coordinator APIs such as blocking lock and leader election,we need a heartbeat API for failure detection,like `LeaseKeepAlive` in Etcd. + +- Blocking lock + +- Sequencer + +# 4. Reference + +[How to do distributed locking](https://martin.kleppmann.com/2016/02/08/how-to-do-distributed-locking.html) + +[The Chubby lock service for loosely-coupled distributed systems](https://static.googleusercontent.com/media/research.google.com/zh-TW//archive/chubby-osdi06.pdf) \ No newline at end of file diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/design/notify/phone_call.md b/docs/en/design/notify/phone_call.md similarity index 100% rename from docs/i18n/en-US/docusaurus-plugin-content-docs/current/design/notify/phone_call.md rename to docs/en/design/notify/phone_call.md diff --git a/docs/en/design/pluggable/design.md b/docs/en/design/pluggable/design.md new file mode 100644 index 0000000000..e17384f56e --- /dev/null +++ b/docs/en/design/pluggable/design.md @@ -0,0 +1,41 @@ +# Pluggable Component Design Document + +## Background + +Currently, the components of Layotto are implemented in Layotto's projects, which requires users to develop new components using Golang language and implement them in the Layotto project before compiling them uniformly. +It is very unfriendly for multilingual users, so Layotto needs to provide the capability of pluggable components, allowing users to implement their own components in any language. Layotto communicates with external components through the GRPC protocol. + +## Programme + +- Implementing local cross language component service discovery based on UDS (Unix domain socket) to reduce communication overhead. +- Implement cross language implementation capabilities for components based on protobuf. + +## Data Flow Architecture + + + +This is the data flow starting from the current user's call to SDK. +The dashed portion is the data flow that the pluggable component primarily participates in. + +### Component Discovery + + + +As shown in the above figure, the user-defined component starts the socket service and places the socket file in the specified directory. +When Layotto starts, it will read all socket files in the directory (skipping folders) and establish a socket connection. + +At present, layotto aligns with dapr and is not responsible for the lifecycle of user components. +If the user components are offline during the service period, there will be no reconnection, and the component service cannot be used. + +Based on the usage of the community, it will be decided whether Layotto needs to support a process management module or use a separate service for management. + +Due to the incomplete support for UDS in Windows and the cancellation of compatibility with Windows by Layotto itself, +the new feature adopts a UDS discovery mode that is not compatible with Windows systems. + +## Component Register + +- As shown in the data flow framework composition above, the components registered by the user need to implement the GRPC service defined by the pluggable proto. +Layotto will generate golang's grpc file based on the protobuf idl. Here Corresponds to the wrap component in the data flow diagram. +- There is no difference between wrap component and build in component for layotto runtime, and there is no special perception for users. +- Layotto uses the GRPC reflect library to obtain which components are implemented by the user's provided services, and registers them in the global component registry for users to use. + diff --git a/docs/en/design/pluggable/usage.md b/docs/en/design/pluggable/usage.md new file mode 100644 index 0000000000..7c6ac73e31 --- /dev/null +++ b/docs/en/design/pluggable/usage.md @@ -0,0 +1,57 @@ +# Pluggable Component Usage Guide + +This example demonstrates how users can implement and register their own components through the pluggable component capabilities provided by Layotto. +And verify the correctness of your component writing through Layotto SDK calls. + +## step1.Write and run pluggable components + +Next, run the already written code + +```shell +cd demo/pluggable/hello +go run . +``` + +Printing the following result indicates successful service startup + +```shell +start grpc server +``` + +>1. Taking the go implementation of the `hello` component as an example, find the corresponding component's proto file in `layotto/spec/proto/pluggable` and generate the corresponding implementation language's grpc file. +The Go language's pb file has been generated and placed under `spec/proto/pluggable/v1`, and users can directly reference it when using it. +>2. In addition to implementing the interfaces defined in the protobuf file, the component also needs to use socket mode to start the file and store the socket file in the default path of `/tmp/runtime/component-sockets`, +You can also use the environment variable `LAYOTTO_COMPONENTS_SOCKETS_FOLDER` modify the sock storage path location. +>3. In addition, users also need to register the reflection service in the GRPC server, which is used to obtain the specific implementation interface spec of the GRPC service during layotto service discovery. For specific code, please refer to `demo/pluggable/hello/main.go` + +## step2. Launch Layotto + +```shell +cd cmd/layotto +go build -o layotto . +./layotto start -c ../../configs/config_hello_component.json +``` + +> The type of the component filled in the configuration file is `hello-grpc-demo`, which is determined by the prefix name of the socket file. +> The configuration items are consistent with registering regular hello components. +> Provide metadata items for users to set custom configuration requirements. + +## step3. Component verification + +Based on existing component testing code, test the correctness of user implemented pluggable components. + +```shell +cd demo/hello/common +go run . -s helloworld +``` + +The program outputs the following results to indicate successful registration and operation of pluggable components. + +```shell +runtime client initializing for: 127.0.0.1:34904 +hello +``` + +## Understand the implementation principle of Layotto pluggable components + +If you are interested in the implementation principles or want to extend some functions, you can read the [Design Document for Pluggable Components](en/design/pluggable/design.md) \ No newline at end of file diff --git a/docs/en/design/pubsub/pubsub-api-and-compability-with-dapr-component.md b/docs/en/design/pubsub/pubsub-api-and-compability-with-dapr-component.md new file mode 100644 index 0000000000..67e71b5d4a --- /dev/null +++ b/docs/en/design/pubsub/pubsub-api-and-compability-with-dapr-component.md @@ -0,0 +1,149 @@ +# Pub/Sub API and compatibility with Dapr's packages +# 1. Requirements +1. Support Pub/Sub API +2. The architecture can reuse Dapr's packages as much as possible + +# 2. High-level design +## 2.1. Architecture: whether to reuse Dapr's sdk and proto +In order to develop a set of universally accepted API specs with the Dapr and Envoy communities in the future, we try to be consistent with the Dapr API at present. + +Dapr's component library can be reused directly; the following discusses whether sdk and proto are reused and how to reuse. + +### The problems we are facing + +1. The SDK of dapr is hard-coded to call the package name of the API, and there is 'dapr' word in the name +  +2. We will have differentiated requirements in the future, such as new fields and new APIs. If we use dapr.proto directly, it will be inflexible +### Solution + +#### Do not reuse sdk and proto; move the proto file to a neutral path + + +We first define an api-spec.proto, this proto is a superset of dapr API, and the path name is neutral without the word 'layotto' or 'dapr'.Based on this proto, we can develop a neutral RuntimeAPI sdk. + +Later, try to promote the proto into an api-spec accepted by the runtime community, or rebuild a path-neutral api-spec.proto with other communities. + +It does not matter if the proto changes during the promotion process. Layotto internally extracts an API layer under the proto to prevent proto changes; + +If it is not easy to push, we can write a dapr adapter in the neutral SDK in the short term, and use our SDK to adjust dapr and layotto: + + +Advantages: + +1. Neat and tidy. If you want to reuse Dapr's sdk and proto, there is an inevitable problem: when the API and dapr are different, you need to encapsulate a layer of your own logic, which will bring complexity, hacky, a sense of copycat, and raise the difficulty of code reading. +1. Extendible when the APIs are different from Dapr's + +Disadvantages: + +1. Subsequent Dapr client or proto changes, we may not know, resulting in inconsistencies + + +## 2.2. API Design +### 2.2.1. Design principle: How to add fields to Dapr's API +We want to reuse Dapr API, but in the long run, there will definitely be customization requirements. When our API and dapr's are different (for example, we just want to add a new field to a certain API of Dapr), should we create a new method name or just add a field to the original method? + +If we add a field to the original method, it may cause field conflicts. + +After serveral discussion,we finally decide to add fields directly in that situation.Conflicts of API are inevitable (of course,we will try to raise pull requests to the Dapr community to avoid conflicts) + +In the future, when everyone really sits together to reach a consensus and build api-spec, a new proto with a new path will be created. Anyway, there will be a new proto at that time, so don't worry about the current conflict. + +### 2.2.2. Between APP and Layotto +Use the same grpc API as Dapr + +```protobuf +service AppCallback { + // Lists all topics subscribed by this app. + rpc ListTopicSubscriptions(google.protobuf.Empty) returns (ListTopicSubscriptionsResponse) {} + + // Subscribes events from Pubsub + rpc OnTopicEvent(TopicEventRequest) returns (TopicEventResponse) {} + +} +``` + +```protobuf +service Dapr { + // Publishes events to the specific topic. + rpc PublishEvent(PublishEventRequest) returns (google.protobuf.Empty) {} +} + +``` + +### 2.2.3. Between Layotto and Component +Use the same as Dapr; +PublishRequest.Data and NewMessage.Data put json data conforming to CloudEvent 1.0 specification (can be deserialized and put into map[string]interface{}) + +```go +// PubSub is the interface for message buses +type PubSub interface { + Init(metadata Metadata) error + Features() []Feature + Publish(req *PublishRequest) error + Subscribe(req SubscribeRequest, handler func(msg *NewMessage) error) error + Close() error +} + +// PublishRequest is the request to publish a message +type PublishRequest struct { + Data []byte `json:"data"` + PubsubName string `json:"pubsubname"` + Topic string `json:"topic"` + Metadata map[string]string `json:"metadata"` +} + + +// NewMessage is an event arriving from a message bus instance +type NewMessage struct { + Data []byte `json:"data"` + Topic string `json:"topic"` + Metadata map[string]string `json:"metadata"` +} + +``` + +### 2.2.4. How does the sidecar know which port to call back + +Configure the callback port at startup. The price is that the sidecar can only serve one process. + +Temporarily choose this plan in this issue + +### 2.2.5. How to keep the subscription list real-time + +The app is called when the sidecar starts, and the subscription relationship is obtained at that time. Therefore, there are requirements for the startup sequence. Start the app first. + +It can be optimized into a timed polling mechanism in the future + +### 2.2.6. Does the subscription relationship support declarative configuration? + +In the first phase, only the way of opening an API for callback is supported, and the subsequent optimization will be declarative configuration or dynamic configuration. + +## 2.3. Config Design + + +# 3. Future Work +## A Bigger Control Plane + +The Control Plane in the Service Mesh era only serves RPC, but in the Runtime API era, component configuration also needs to be distributed by the cluster; components also need service discovery and routing, so components also need their own Control Plane. + +It is convenient to have a Bigger Control Plane that integrates RPC and all middleware configuration data + +Maybe we have to extend the xDS protocol, like 'runtime Discovery Service'. + +## Subscription relationship support configuration + +The subscription relationship is now obtained by the callback mechanism.We want the subscription relationship be obtained through configuration. + +## appcallback support TLS + + +## Separate component configuration and personality configuration (callback port, app-id) +The current component configuration and app personality configuration (callback port, app-id) are put together, and there are some problems: + +1. It's not easy to distribute the configuration to the whole cluster +1. Can't do component access control (for example, Dapr can restrict app-id1 to only access topic_id1) + + +Need to refactor the original component logic. + +## Tracing diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/design/rpc/rpc-design-doc.md b/docs/en/design/rpc/rpc-design-doc.md similarity index 84% rename from docs/i18n/en-US/docusaurus-plugin-content-docs/current/design/rpc/rpc-design-doc.md rename to docs/en/design/rpc/rpc-design-doc.md index fbd98b37a9..4ca4ea4608 100644 --- a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/design/rpc/rpc-design-doc.md +++ b/docs/en/design/rpc/rpc-design-doc.md @@ -1,6 +1,6 @@ -# RPC DESIGN +RPC DESIGN -## API +### API runtime rpc API is same with Dapr. ### Core Abstraction @@ -9,9 +9,9 @@ in order to decoupling with pb definition，add independent RPC abstrations. - invoker： provide complete rpc ability，currently only Mosn invoker - callback：before/after filter，extend with custom logic(eg: protocol convertion) - channel：send request and receive response, talk to diffrent transport protocol（http、bolt...) - + due to Mosn do all the dirty work, a lightweight framework is enough for layotto currently. - +  @@ -48,9 +48,9 @@ In layotto, we design a convenient way to support xprotocols. The only task need "channel": [{ "size": 16, // analogy to connection nums "protocol": "http", // communicate with mosn via this protocol - "listener": "egress_runtime_http" // mosn's protocol listener name - }] - } - } - } + "listener": "egress_runtime_http" // mosn's protocol listener name + }] + } + } +} ``` \ No newline at end of file diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/development/CONTRIBUTING.md b/docs/en/development/CONTRIBUTING.md similarity index 100% rename from docs/i18n/en-US/docusaurus-plugin-content-docs/current/development/CONTRIBUTING.md rename to docs/en/development/CONTRIBUTING.md diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/development/commands.md b/docs/en/development/commands.md similarity index 100% rename from docs/i18n/en-US/docusaurus-plugin-content-docs/current/development/commands.md rename to docs/en/development/commands.md diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/development/component_ref/component_ref.md b/docs/en/development/component_ref/component_ref.md similarity index 97% rename from docs/i18n/en-US/docusaurus-plugin-content-docs/current/development/component_ref/component_ref.md rename to docs/en/development/component_ref/component_ref.md index 4fb806b747..5a455a576a 100644 --- a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/development/component_ref/component_ref.md +++ b/docs/en/development/component_ref/component_ref.md @@ -1,13 +1,13 @@ -# layotto component reference +## layotto component reference -## Background +### Background When a component starts, it may need to use another component's skill. For example, when the `sequencer` component `A` starts, it needs to read its settings from the `config` component `B`. To make this happen, layotto offers the "component reference" feature. This feature lets component A use the features of component B. ### Related Designs -Currently, other components can only reference two types of components: ConfigStore and SecretStore. These are used to get configuration and secret keys. +Currently, other components can only reference two types of components: ConfigStore and SecretStore. These are used to get configuration and secret keys. The "referenced" components must implement the interface : diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/development/contributing-doc.md b/docs/en/development/contributing-doc.md similarity index 91% rename from docs/i18n/en-US/docusaurus-plugin-content-docs/current/development/contributing-doc.md rename to docs/en/development/contributing-doc.md index bc537ac24a..41ff32d759 100644 --- a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/development/contributing-doc.md +++ b/docs/en/development/contributing-doc.md @@ -8,7 +8,7 @@ This document describes how to modify/add documents. Documentation for this repo Documents are stored in the 'docs/' directory, where 'docs/en' stores English documents and 'docs/zh' stores Chinese documents. - + ## 2. Documentation Site Description Files under docs/ directory will be automatically deployed to github pages and rendered through [docsify](https://docsify.js.org/#/). @@ -19,7 +19,7 @@ Generally speaking, after the .md file is merged into the main branch, you can s ### step 1. Write a new markdown file To add a document, create a folder and a .md file based on the directory structure. For example, if you want to write a design document for the distributed lock API, just create a new directory: - + ### step 2. Update the sidebar Remember to update the sidebar after adding new documents or revising existing documents. @@ -42,9 +42,9 @@ The hyperlink mentioned here is the kind of links that will jump to other docume ### Incorrect Syntax If you try to create a hyperlink with a relative path, then a 404 page will appear once you clicked it: - + - + ### Correct Syntax @@ -52,7 +52,7 @@ There are two suggested ways to write hyperlinks: a. Use a path relative to the 'docs/' directory. Such as: - + b. Use the full Url. Such as: @@ -63,7 +63,7 @@ see [runtime_config.json](https://github.com/mosn/layotto/blob/main/configs/runt ## 5. Tips on image links Images are stored under docs/img/ directory for the purpose that the Docsify site can access it - + It is recommended to use the full path when referencing images in documents, to avoid a bunch of messy path problems. diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/development/developing-api.md b/docs/en/development/developing-api.md similarity index 99% rename from docs/i18n/en-US/docusaurus-plugin-content-docs/current/development/developing-api.md rename to docs/en/development/developing-api.md index 0a4bce2db8..b965e9e7b4 100644 --- a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/development/developing-api.md +++ b/docs/en/development/developing-api.md @@ -78,7 +78,7 @@ need to have: Correct example：[Dapr pub-sub quickstart](https://github.com/dapr/quickstarts/tree/v1.0.0/pub-sub) Before the operation, explain what effect this demo want to achieve with illustration - + Counter-example: The document only writes operation steps 1234, and users do not understand what they want to do. @@ -102,7 +102,7 @@ Need to have ： ##### How to use this API - List of interfaces.For example： - + List out which interfaces are there. On the one hand, the users of the province go to the proto and don’t know which APIs are related. On the other hand, it can avoid the disgust of users due to the lack of interface documentation - About the interface`s input and output parameters: use proto comments as interface documentation diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/development/developing-component.md b/docs/en/development/developing-component.md similarity index 87% rename from docs/i18n/en-US/docusaurus-plugin-content-docs/current/development/developing-component.md rename to docs/en/development/developing-component.md index 4be0c27418..e484bfe9cc 100644 --- a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/development/developing-component.md +++ b/docs/en/development/developing-component.md @@ -16,7 +16,7 @@ When developing new components, you can refer to the existing components. For ex The folder name can use the component name, referring to the redis component below - + Tools you may use in the process of development (for the purpose of reference only, hope to simplify the development) : @@ -43,23 +43,23 @@ components/configstores/ apollo/configstore_test.go: First, in configstore.go, encapsulate all calls to the SDK, network and Apollo into a single interface. - - + + Then, encapsulate your code that calls the SDK and network into a struct which achieves that interface: - + Once you've done this refactoring, your code is testable (this is part of the idea of test-driven development, refactoring code into a form that can be injectable in order to improve its testability) Next, we can mock that interface when we write ut: - + Just mock it into the struct you want to test, and test it. - + Note: Generally, during "integration test", network call will be made and a normal ZooKeeper or Redis will be called. On contract, the single test focuses on the local logic, and will not call the real environment @@ -72,10 +72,10 @@ So how should let Layotto load the components at startup? Need to integrate new components in cmd/layotto/main.go, including: ### 3.1. Import your components in main.go - + ### 3.2. Register your component in the NewRuntimeGrpcServer function of main.go - + After that, Layotto initializes the ZooKeeper component if the user has configured "I want to use ZooKeeper" in the Layotto configuration file @@ -93,7 +93,7 @@ So how to configure when users want to use Zookeeper? We need to provide a sampl We can copy a json configuration file from another component. For example, copy configs/config_redis.json and paste it into configs/config_zookeeper.json when developing a plug-in component Then edit and modify the configuration shown below: - + @@ -103,12 +103,12 @@ We need a client demo, such as the distributed lock client demo that has two cor #### a. If the component has a generic client, it doesn't need to be developed If there is a common folder under demo directory, it means the demo is a general purpose demo, which can be used by different components. You can pass the storeName parameter on the command line, and you don't need to develop a demo if you have this - + #### b. If the component does not have a generic client or requires custom metadata arguments, copy and paste them For example, when implementing distributed locks using ZooKeeper, you need some custom configurations. Then you can write your demo based on the Redis demo - + Note: If there are errors in the demo code that shouldn't be there , you can panic directly. Later, we will directly use demo to run the integration test. If panic occurs, it means that the integration test fails. For example the demo/lock/redis/client.go: @@ -122,19 +122,19 @@ Note: If there are errors in the demo code that shouldn't be there , you can pan ``` ### 4.3. Refer to the QuickStart documentation to start Layotto and Demo and see if any errors are reported -For example, refer to the [QuickStart documentation of the Distributed Lock API](start/lock/start.md) , start your dependent environment (such as ZooKeeper), and start Layotto (remember to use the configuration file you just added!). And check for errors. +For example, refer to the [QuickStart documentation of the Distributed Lock API](zh/start/lock/start.md) , start your dependent environment (such as ZooKeeper), and start Layotto (remember to use the configuration file you just added!). And check for errors. Note: The following Error is ok, just ignore it - + Start demo and call Layotto to see if any errors are reported. If it is a universal client, you can pass storeName with -s storeName in the command line - + If there is no error when running, it means the test passed! ## 5、New component description documents When the above code work is completed , it is better to add the configuration documentation of the component, explaining what configuration items the component supports and how to start the environment that the component depends on (for example, how to start ZooKeeper with Docker). -You can refer to the [Redis component description of the Lock API (Chinese)](component_specs/lock/redis.md) and [the Redis component description of the Lock API (English)](component_specs/lock/redis.md), also can copy and paste change. \ No newline at end of file +You can refer to the [Redis component description of the Lock API (Chinese)](zh/component_specs/lock/redis.md) and [the Redis component description of the Lock API (English)](en/component_specs/lock/redis.md), also can copy and paste change. \ No newline at end of file diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/development/github-workflows.md b/docs/en/development/github-workflows.md similarity index 93% rename from docs/i18n/en-US/docusaurus-plugin-content-docs/current/development/github-workflows.md rename to docs/en/development/github-workflows.md index b9947b2359..1da577af77 100644 --- a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/development/github-workflows.md +++ b/docs/en/development/github-workflows.md @@ -85,7 +85,7 @@ Layotto Env Pipeline Task Trigger Events: ## Layotto Dev Pipeline 🌊 (Before Merged) - + ### Job Task Content @@ -121,7 +121,7 @@ The layotto dev pipeline (before merged) is mainly responsible for verifying th ## Layotto Dev Pipeline 🌊 (After Merged) - + ### Job Task Content @@ -160,7 +160,7 @@ The layotto dev pipeline (after merged) is mainly responsible for the verificat ## Layotto Release Pipeline 🌊 - + ### Job Task Content @@ -177,9 +177,9 @@ The layotto release pipeline is mainly responsible for the release and verifica + Linux AMD64 Artifact : Build linux amd64 binary verification for code + Linux ARM64 Artifact : Build linux arm64 binary verification for code + Linux AMD64 WASM Artifact : Build linux AMD64 binary verification for layotto wasm -+ Linux AMD64 WASM Image : Release the latest version of layotto wasm image. The image specification is `layotto/faas-amd64:{latest_tagname}` -+ Linux AMD64 Image : Release the latest version of layotto wasm image. The image specification is `layotto/layotto:{latest_tagname}` -+ Linux ARMD64 Image : Release the latest version of layotto wasm image. The image specification is `layotto/layotto.arm64:{latest_tagname}` ++ Linux AMD64 WASM Image : Release the latest version of layotto wasm image. The image specification is layotto/faas-amd64:{latest_tagname} ++ Linux AMD64 Image : Release the latest version of layotto wasm image. The image specification is layotto/layotto:{latest_tagname} ++ Linux ARMD64 Image : Release the latest version of layotto wasm image. The image specification is layotto/layotto.arm64:{latest_tagname} ### Job Trigger Event diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/development/test-quickstart.md b/docs/en/development/test-quickstart.md similarity index 99% rename from docs/i18n/en-US/docusaurus-plugin-content-docs/current/development/test-quickstart.md rename to docs/en/development/test-quickstart.md index d8f8785b3d..f489ea64ae 100644 --- a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/development/test-quickstart.md +++ b/docs/en/development/test-quickstart.md @@ -6,7 +6,7 @@ So we need to test Quickstart regularly to make sure it works. But the process of manually testing Quickstart periodically and fixing exceptions in the documentation is too time-consuming. -
+
It's a pain in the ass!
diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/operation/README.md b/docs/en/operation/README.md
similarity index 95%
rename from docs/i18n/en-US/docusaurus-plugin-content-docs/current/operation/README.md
rename to docs/en/operation/README.md
index 0be93f1eb3..70bf84a217 100644
--- a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/operation/README.md
+++ b/docs/en/operation/README.md
@@ -10,7 +10,7 @@ There are some ways to deploy Layotto that you can find below.
### Deploy Layotto using released binaries
-You can start Layotto directly via executing the binary file. Refer to the [Quick start](start) guide.
+You can start Layotto directly via executing the binary file. Refer to the [Quick start](en/start) guide.
### Deploy using Docker
@@ -25,7 +25,7 @@ It does not contain a `config.json` configuration file in the image, you can mou
docker run -v "$(pwd)/configs/config.json:/runtime/configs/config.json" -d -p 34904:34904 --name layotto layotto/layotto start
```
-Of course, you can also run Layotto and other systems (such as Redis) at the same time via docker-compose. Refer to the [Quick start](start/state/start?id=step-1-deploy-redis-and-layotto)
+Of course, you can also run Layotto and other systems (such as Redis) at the same time via docker-compose. Refer to the [Quick start](en/start/state/start?id=step-1-deploy-redis-and-layotto)
### Deploy on Kubernetes
@@ -51,7 +51,7 @@ The principle of this script is to replace the binary file in the MOSN proxyv2 i
You can prepare your own image and K8s configuration file, then deploy Layotto via Kubernetes.
-We are working on the official Layotto image and the solution for deploying to Kubernetes using Helm, so feel free to join us to build it. More details in `[https://mosn.io/docs/concept/extensions/](https://mosn.io/docs/concept/extensions/) - -Mosn Stream Filter Extension - - - -### Code in： [flowcontrol代码](https://github.com/mosn/mosn/tree/master/pkg/filter/stream/flowcontrol) - -### stream_filter_factory.go analysis - -This class is a factory class to create StreamFilter. - -Some constant values are defined for default values - - - -Defines the restricted stream config class to load yaml definition and parse production corresponding functions - - - -init() Inner initialization is the storage of name and corresponding constructor to the filter blocking plant map - - - -Highlight createRpcFlowControlFilterFactory Production rpc Current Factory - - - -Before looking at streamfilter, we see how factory classes are producing restricted streamers - - - -Limit the streaming to the restricted stream chain structure to take effect in sequential order. - -CreateFilterChain method adds multiple filters to the link structure - - - -We can see that this interface is achieved by a wide variety of plant types, including those that we are studying today. - - - -### Stream_filter.go Analysis - - - -## Overall process： - -Finally, we look back at the overall process progress: - -1. Starting from the initialization function of stream_filter_factory.go, the program inserted createRpcFlowControlFilterFactory. - -2. Mosn created a filter chain (code position[factory.go](https://github.com/mosn/mosn/tree/master/pkg/streamfilter/factory.go)) by circulating CreateFilterChain to include all filters in the chain structure, including our master restricted streaming today. - -3. Create Limiter NewStreamFilter(). - -4. OnReceive() and eventually by sentinel (whether the threshold has been reached, whether to release traffic or stop traffic, StreamFilterStop or StreamFilterContinue). diff --git a/docs/i18n/en-US/docusaurus-plugin-content-blog/code/layotto-rpc/index.md b/docs/i18n/en-US/docusaurus-plugin-content-blog/code/layotto-rpc/index.md deleted file mode 100644 index 02dd0e66c0..0000000000 --- a/docs/i18n/en-US/docusaurus-plugin-content-blog/code/layotto-rpc/index.md +++ /dev/null @@ -1,946 +0,0 @@ -# Layotto Source Parsing — Processing RPC requests - -> This paper is based on the Dubbo Json RPC as an example of the Layotto RPC processing. -> -> by：[Wang Zhilong](https://github.com/rayowang) | 21April 2022 - -- [overview](#overview) -- [source analysis](#source analysis) - - [0x00 Layotto initialize RPC](#_0x00-layotto-initializ-rpc) - - [0x01 Dubbo-go-sample client to request request] (#_0x01-dubbo-go-sample-client-request request) - - [0x02 Mosn EventLoop Reader Processing Request Data](#_0x02-mosn-eventloop-read processing request) - - [0x03 Grpc Sever as NetworkFilter to process requests](#_0x03-grpc-sever as -networkfilter-process requests) - - [0x04 Layotto send RPC requests and write to Local Virtual Connections](#_0x04-layotto -rpc-request and write to -local-virtual connection) - - [0x05 Mosn reads Remote and executes Filter and Proxy Forwarding](#_0x05-mosn-read-remote-remote--and --filter-and proxy forward) - - [0x06 Dubbo-go-sample server received response to request return] (#_0x06-dubbo-go-sample-server-received response return) - - [0x07 Mosn Framework handles response and writes back to Remote Virtual Connections](#_0x07-mosn-Framework handles response and -remote-virtual connection) - - [0x08 Layotto receive RPC responses and read Local Virtual Connections](#_0x08-layotto-receive-rpc-response and read -local-virtual connection) - - [0x09 Grpc Sever processed data frames returned to client](#_0x09-grpc-sever processed frame returned to client) - - [0x10 Dubbo-go-sample client receiving response](#_0x10-dubbo-go-sample-client-receiving response) -- [summary](#summary) - -## General description - -Layotto has a clear and rich semiconductor API as a distributed prototype collection of prototype language distinguished from the network proxy service Mesh and using standard protocol API, which is part of the RPC API.Through RPC API app developers can interact with local Layotto instances of applications that also use the Sidecar architecture, thereby indirectly calling different service methods and using built-in capabilities to perform distributive tracking and diagnosis, traffic control, error handling, secure links, etc.and Layotto is based on the Grpc handler design, using the X-Protocol protocol for secure and reliable communications, except for Http/Grpc communications with other services.As shown in the following code, the RPC API interface is in line with Dapr and is available for RPC calls through the Grpc interface InvokeService. - -```go -type DaprClient interface { - // Invokes a method on a remote Dapr app. - InvokeService(ctx context.Context, in *InvokeServiceRequest, opts ...grpc.CallOption) (*v1.InvokeResponse, error) - ... -} -``` - -## Source analysis - -For ease of understanding, from outside to inside, from inside to outside, from flow to source code, that is, from Client, through one layer of logic to the Server receiving a return response to requests, from another layer of return to client, and from one layer of analysis of Layotto RPC processes, split into 10 steps.Also, since the content of Gypc Client and Server handshakes and interactions is not the focus of this paper, the analysis is relatively brief and the other steps are relatively detailed and one can move directly from the directory to the corresponding step depending on his or her case. - -Note：based on commit hash：1d2bed68c3b2372c34a12aeed41be125a4fdd15a - -### 0x00 Layotto initialize RPC - -Layotto starts the process involves a large number of processes in which only the initialization of the process related to RPC and described below is analyzed because Layotto is based on Mosn and is therefore starting from the Main function, urfave/cli library calls Mosn StageManager Mos, thus initializing GrpcServer in Mosn NetworkFilter as follows. - -```go -mosn.io/mosn/pkg/stagemanager.(*StageManager).runInitStage at stage_manager.go -=> -mosn.io/mosn/pkg/mosn.(*Mosn).initServer at mosn.go -=> -mosn.io/mosn/pkg/filter/network/grpc.(*grpcServerFilterFactory).Init at factory.go -=> -mosn.io/mosn/pkg/filter/network/grpc.(*Handler).New at factory.go -// 新建一个带有地址的 Grpc 服务器。同一个地址返回同一个服务器，只能启动一次 -func (s *Handler) New(addr string, conf json.RawMessage, options ...grpc.ServerOption) (*registerServerWrapper, error) { - s.mutex.Lock() - defer s.mutex.Unlock() - sw, ok := s.servers[addr] - if ok { - return sw, nil - } - ln, err := NewListener(addr) - if err != nil { - log.DefaultLogger.Errorf("create a listener failed: %v", err) - return nil, err - } - // 调用 NewRuntimeGrpcServer - srv, err := s.f(conf, options...) - if err != nil { - log.DefaultLogger.Errorf("create a registered server failed: %v", err) - return nil, err - } - sw = ®isterServerWrapper{ - server: srv, - ln: ln, - } - s.servers[addr] = sw - return sw, nil -} -= -main.NewRunvtimeGrpcServer at main.go -=> -mosn.io/layotto/pkg/runtime.(*MosnRuntime).initRuntime at runtime.go -=> -mosn.io/layotto/pkg/runtime.(*MosnRuntime).initRpcs at runtime.go -=> -mosn.io/layotto/components/rpc/invoker/mosn.(*mosnInvoker).Init at mosninvoker.go -func (m *mosnInvoker) Init(conf rpc.RpcConfig) error { - var config mosnConfig - if err := json.Unmarshal(conf.Config, &config); err != nil { - return err - } - - // 初始化 RPC 调用前的 Filter - for _, before := range config.Before { - m.cb.AddBeforeInvoke(before) - } - - // 初始化 RPC 调用后的 Filter - for _, after := range config.After { - m.cb.AddAfterInvoke(after) - } - - if len(config.Channel) == 0 { - return errors.New("missing channel config") - } - - // 初始化与 Mosn 通信使用的通道、协议及对应端口 - channel, err := channel.GetChannel(config.Channel[0]) - if err != nil { - return err - } - m.channel = channel - return nil -} -... -// 完成一些列初始化后在 grpcServerFilter 中启动 Grpc Server -mosn.io/mosn/pkg/filter/network/grpc.(*grpcServerFilterFactory).Init at factory.go -func (f *grpcServerFilterFactory) Init(param interface{}) error { - ... - opts := []grpc.ServerOption{ - grpc.UnaryInterceptor(f.UnaryInterceptorFilter), - grpc.StreamInterceptor(f.StreamInterceptorFilter), - } - // 经过上述初始化，完成 Grpc registerServerWrapper 的初始化 - sw, err := f.handler.New(addr, f.config.GrpcConfig, opts...) - if err != nil { - return err - } - // 启动 Grpc sever - sw.Start(f.config.GracefulStopTimeout) - f.server = sw - log.DefaultLogger.Debugf("grpc server filter initialized success") - return nil -} -... -// StageManager 在 runInitStage 之后进入 runStartStage 启动 Mosn -func (stm *StageManager) runStartStage() { - st := time.Now() - stm.SetState(Starting) - for _, f := range stm.startupStages { - f(stm.app) - } - - stm.wg.Add(1) - // 在所有启动阶段完成后启动 Mosn - stm.app.Start() - ... -} -``` - -### 0x01 Dubbo-go-sample client request - -Follow the example of [Dubbo Json Rpc Example](https://mosn.io/layotto/#/en/start/rpc/dub_json_rpc) - -```shell -go un demo/rpc/dubbo_json_rpc/dub_json_client/client.go -d '{"jsonrpc": "2.0", "method":"GetUser", "params":["A003"],"id":9527}' -``` - -Use Layotto for App Gypc API InvokeService initiate RPC calls, data filling and connecting processes leading to the dispatch of data to Layotto via SendMsg in Grpc clientStream, as follows. - -```go - -func main() { - data := flag.String("d", `{"jsonrpc":"2.0","method":"GetUser","params":["A003"],"id":9527}`, "-d") - flag.Parse() - - conn, err := grpc.Dial("localhost:34904", grpc.WithInsecure()) - if err != nil { - log.Fatal(err) - } - - cli := runtimev1pb.NewRuntimeClient(conn) - ctx, cancel := context.WithCancel(context.TODO()) - defer cancel() - // 通过 Grpc 接口 InvokeService 进行 RPC 调用 - resp, err := cli.InvokeService( - ctx, - // 使用 runtimev1pb.InvokeServiceRequest 发起 Grpc 请求 - &runtimev1pb.InvokeServiceRequest{ - // 要请求的 server 接口 ID - Id: "org.apache.dubbo.samples.UserProvider", - Message: &runtimev1pb.CommonInvokeRequest{ - // 要请求的接口对应的方法名 - Method: "GetUser", - ContentType: "", - Data: &anypb.Any{Value: []byte(*data)}, - HttpExtension: &runtimev1pb.HTTPExtension{Verb: runtimev1pb.HTTPExtension_POST}, - }, - }, - ) - if err != nil { - log.Fatal(err) - } - - fmt.Println(string(resp.Data.GetValue())) -} -=> -mosn.io/layotto/spec/proto/runtime/v1.(*runtimeClient).InvokeService at runtime.pb.go -=> -google.golang.org/grpc.(*ClientConn).Invoke at call.go -=> -google.golang.org/grpc.(*clientStream).SendMsg at stream.go -=> -google.golang.org/grpc.(*csAttempt).sendMsg at stream.go -=> -google.golang.org/grpc/internal/transport.(*http2Client).Write at http2_client.go -``` - -### 0x02 Mosn EventLoop Reader Processing Request Data - -The kernel from Layotto mentioned above is a mock-up of Mosn, so when network connection data arrives, it will first be read and written at the L4 network level in Mosn as follows. - -```go -mosn.io/mosn/pkg/network.(*listener).accept at listener.go -=> -mosn.io/mosn/pkg/server.(*activeListener).OnAccept at handler.go -=> -mosn.io/mosn/pkg/server.(*activeRawConn).ContinueFilterChain at handler.go -=> -mosn.io/mosn/pkg/server.(*activeListener).newConnection at handler.go -=> -mosn.io/mosn/pkg/network.(*connection).Start at connection.go -=> -mosn.io/mosn/pkg/network.(*connection).startRWLoop at connection.go -func (c *connection) startRWLoop(lctx context.Context) { - c.internalLoopStarted = true - - utils.GoWithRecover(func() { - // 读协程 - c.startReadLoop() - }, func(r interface{}) { - c.Close(api.NoFlush, api.LocalClose) - }) - - if c.checkUseWriteLoop() { - c.useWriteLoop = true - utils.GoWithRecover(func() { - // 写协程 - c.startWriteLoop() - }, func(r interface{}) { - c.Close(api.NoFlush, api.LocalClose) - }) - } -} -``` - -In the startRWLoop method, we can see that two separate protocols will be opened to deal with reading and writing operations on the connection: startReadLoop and startWriteLoop; the following streams will be made in startReadLoop; the data read at the network level will be handled by the filterManager filter chain, as follows. - -```go -mosn.io/mosn/pkg/network.(*connection).doRead at connection.go -=> -mosn.io/mosn/pkg/network.(*connection).onRead at connection.go -=> -mosn.io/mosn/pkg/network.(*filterManager).OnRead at filtermanager.go -=> -mosn.io/mosn/pkg/network.(*filterManager).onContinueReading at filtermanager.go -func (fm *filterManager) onContinueReading(filter *activeReadFilter) { - var index int - var uf *activeReadFilter - - if filter != nil { - index = filter.index + 1 - } - - // filterManager遍历过滤器进行数据处理 - for ; index < len(fm.upstreamFilters); index++ { - uf = fm.upstreamFilters[index] - uf.index = index - // 对没有初始化的过滤器调用其初始化方法 OnNewConnection，本例为func (f *grpcFilter) OnNewConnection() api.FilterStatus（向 Listener 发送 grpc 连接以唤醒 Listener 的 Accept） - if !uf.initialized { - uf.initialized = true - - status := uf.filter.OnNewConnection() - - if status == api.Stop { - return - } - } - - buf := fm.conn.GetReadBuffer() - - if buf != nil && buf.Len() > 0 { - // 通知相应过滤器处理 - status := uf.filter.OnData(buf) - - if status == api.Stop { - return - } - } - } -} -=> -mosn.io/mosn/pkg/filter/network/grpc.(*grpcFilter).OnData at filter.go -=> -mosn.io/mosn/pkg/filter/network/grpc.(*grpcFilter).dispatch at filter.go -func (f *grpcFilter) dispatch(buf buffer.IoBuffer) { - if log.DefaultLogger.GetLogLevel() >= log.DEBUG { - log.DefaultLogger.Debugf("grpc get datas: %d", buf.Len()) - } - // 发送数据唤醒连接读取 - f.conn.Send(buf) - if log.DefaultLogger.GetLogLevel() >= log.DEBUG { - log.DefaultLogger.Debugf("read dispatch finished") - } -} -``` - -### 0x03 Grpc Sever processed requests as NetworkFilter - -Reading data from the original connection in the first phase will enter the Grpc Serve handling, the Serve method will use the net.Listener listener, each time a new protocol is launched to handle the new connection (handleRawCon), and a RPC call based on Http2-based transport will be set out below. - -```go -google.golang.org/grpc.(*Server).handleRawConn at server.go -func (s *Server) handleRawConn(lisAddr string, rawConn net.Conn) { - // 校验服务状态 - if s.quit.HasFired() { - rawConn.Close() - return - } - rawConn.SetDeadline(time.Now().Add(s.opts.connectionTimeout)) - conn, authInfo, err := s.useTransportAuthenticator(rawConn) - if err != nil { - ... - } - // HTTP2 握手，创建 Http2Server 与客户端交换帧的初始化信息，帧和窗口大小等 - st := s.newHTTP2Transport(conn, authInfo) - if st == nil { - return - } - - rawConn.SetDeadline(time.Time{}) - if !s.addConn(lisAddr, st) { - return - } - // 创建一个协程进行流处理 - go func() { - s.serveStreams(st) - s.removeConn(lisAddr, st) - }() - ... -} -=> -google.golang.org/grpc.(*Server).serveStreams at server.go -=> -google.golang.org/grpc.(*Server).handleStream at server.go -func (s *Server) handleStream(t transport.ServerTransport, stream *transport.Stream, trInfo *traceInfo) { - // 找到到需要调用的 FullMethod，此例为 spec.proto.runtime.v1.Runtime/InvokeService - sm := stream.Method() - if sm != "" && sm[0] == '/' { - sm = sm[1:] - } - ... - service := sm[:pos] - method := sm[pos+1:] - - // 从注册的 service 列表中找到对应 serviceInfo 对象 - srv, knownService := s.services[service] - if knownService { - // 根据方法名找到单向请求的 md——MethodDesc，此 demo 为 mosn.io/layotto/spec/proto/runtime/v1._Runtime_InvokeService_Handler - if md, ok := srv.methods[method]; ok { - s.processUnaryRPC(t, stream, srv, md, trInfo) - return - } - // 流式请求 - if sd, ok := srv.streams[method]; ok { - s.processStreamingRPC(t, stream, srv, sd, trInfo) - return - } - } - ... -=> -google.golang.org/grpc.(*Server).processUnaryRPC at server.go -=> -mosn.io/layotto/spec/proto/runtime/v1._Runtime_InvokeService_Handler at runtime.pb.go -=> -google.golang.org/grpc.chainUnaryServerInterceptors at server.go -=> -// 服务端单向调用拦截器，用以调用 Mosn 的 streamfilter -mosn.io/mosn/pkg/filter/network/grpc.(*grpcServerFilterFactory).UnaryInterceptorFilter at factory.go -=> -google.golang.org/grpc.getChainUnaryHandler at server.go -// 递归生成链式UnaryHandler -func getChainUnaryHandler(interceptors []UnaryServerInterceptor, curr int, info *UnaryServerInfo, finalHandler UnaryHandler) UnaryHandler { - if curr == len(interceptors)-1 { - return finalHandler - } - - return func(ctx context.Context, req interface{}) (interface{}, error) { - // finalHandler就是mosn.io/layotto/spec/proto/runtime/v1._Runtime_InvokeService_Handler - return interceptors[curr+1](ctx, req, info, getChainUnaryHandler(interceptors, curr+1, info, finalHandler)) - } -} -``` - -### 0x04 Layotto send RPC requests and write to local virtual connections - -The 0x03 process follows Runtime_InvokeService_Handler, converted from the GRPC Default API to Dapr API, entering the light RPC framework provided by Layotto in Mosn, as follows. - -```go -mosn.io/layotto/spec/proto/runtime/v1._Runtime_InvokeService_Handler at runtime.pb.go -=> -mosn.io/layotto/pkg/grpc/default_api.(*api).InvokeService at api.go -=> -mosn.io/layotto/pkg/grpc/dapr.(*daprGrpcAPI).InvokeService at dapr_api.go -=> -mosn.io/layotto/components/rpc/invoker/mosn.(*mosnInvoker).Invoke at mosninvoker.go -// 请求 Mosn 底座和返回响应 -func (m *mosnInvoker) Invoke(ctx context.Context, req *rpc.RPCRequest) (resp *rpc.RPCResponse, err error) { - defer func() { - if r := recover(); r != nil { - err = fmt.Errorf("[runtime][rpc]mosn invoker panic: %v", r) - log.DefaultLogger.Errorf("%v", err) - } - }() - - // 1. 如果超时时间为 0，设置默认 3000ms 超时 - if req.Timeout == 0 { - req.Timeout = 3000 - } - req.Ctx = ctx - log.DefaultLogger.Debugf("[runtime][rpc]request %+v", req) - // 2. 触发请求执行前的自定义逻辑 - req, err = m.cb.BeforeInvoke(req) - if err != nil { - log.DefaultLogger.Errorf("[runtime][rpc]before filter error %s", err.Error()) - return nil, err - } - // 3. 核心调用，下文会进行详细分析 - resp, err = m.channel.Do(req) - if err != nil { - log.DefaultLogger.Errorf("[runtime][rpc]error %s", err.Error()) - return nil, err - } - resp.Ctx = req.Ctx - // 4. 触发请求返回后的自定义逻辑 - resp, err = m.cb.AfterInvoke(resp) - if err != nil { - log.DefaultLogger.Errorf("[runtime][rpc]after filter error %s", err.Error()) - } - return resp, err -} -=> -mosn.io/layotto/components/rpc/invoker/mosn/channel.(*httpChannel).Do at httpchannel.go -func (h *httpChannel) Do(req *rpc.RPCRequest) (*rpc.RPCResponse, error) { - // 1. 使用上一阶段设置的默认超时设置 context 超时 - timeout := time.Duration(req.Timeout) * time.Millisecond - ctx, cancel := context.WithTimeout(req.Ctx, timeout) - defer cancel() - - // 2. 创建连接得到，启动 readloop 协程进行 Layotto 和 Mosn 的读写交互（具体见下文分析） - conn, err := h.pool.Get(ctx) - if err != nil { - return nil, err - } - - // 3. 设置数据写入连接的超时时间 - hstate := conn.state.(*hstate) - deadline, _ := ctx.Deadline() - if err = conn.SetWriteDeadline(deadline); err != nil { - hstate.close() - h.pool.Put(conn, true) - return nil, common.Error(common.UnavailebleCode, err.Error()) - } - // 4. 因为初始化时配置的 Layotto 与 Mosn 交互使用的是 Http 协议，所以这里会构造 Http 请求 - httpReq := h.constructReq(req) - defer fasthttp.ReleaseRequest(httpReq) - - // 借助 fasthttp 请求体写入虚拟连接 - if _, err = httpReq.WriteTo(conn); err != nil { - hstate.close() - h.pool.Put(conn, true) - return nil, common.Error(common.UnavailebleCode, err.Error()) - } - - // 5. 构造 fasthttp.Response 结构体读取和解析 hstate 的返回，并设置读取超时时间 - httpResp := &fasthttp.Response{} - hstate.reader.SetReadDeadline(deadline) - - // 在 Mosn 数据返回前这里会阻塞，readloop 协程读取 Mosn 返回的数据之后流程见下述 0x08 阶段 - if err = httpResp.Read(bufio.NewReader(hstate.reader)); err != nil { - hstate.close() - h.pool.Put(conn, true) - return nil, common.Error(common.UnavailebleCode, err.Error()) - } - h.pool.Put(conn, false) - ... -} -=> -mosn.io/layotto/components/rpc/invoker/mosn/channel.(*connPool).Get at connpool.go -// Get is get wrapConn by context.Context -func (p *connPool) Get(ctx context.Context) (*wrapConn, error) { - if err := p.waitTurn(ctx); err != nil { - return nil, err - } - - p.mu.Lock() - // 1. 从连接池获取连接 - if ele := p.free.Front(); ele != nil { - p.free.Remove(ele) - p.mu.Unlock() - wc := ele.Value.(*wrapConn) - if !wc.isClose() { - return wc, nil - } - } else { - p.mu.Unlock() - } - - // 2. 创建新的连接 - c, err := p.dialFunc() - if err != nil { - p.freeTurn() - return nil, err - } - wc := &wrapConn{Conn: c} - if p.stateFunc != nil { - wc.state = p.stateFunc() - } - // 3. 启动 readloop 独立协程读取 Mosn 返回的数据 - if p.onDataFunc != nil { - utils.GoWithRecover(func() { - p.readloop(wc) - }, nil) - } - return wc, nil -} -=> -``` - -The creation of a new connection in the second step above requires attention by calling dialFunc func() in the protocol that initialized the init phase (net.Conn, error), because the configuration interacted with Mosn with Http protocols, this is newHttpChanel, which is currently supported by the Bolt, Dubbo et al. - -```go -mosn.io/layotto/components/rpc/invoker/mosn/channel.newHttpChannel at httpchannel.go -// newHttpChannel is used to create rpc.Channel according to ChannelConfig -func newHttpChannel(config ChannelConfig) (rpc.Channel, error) { - hc := &httpChannel{} - // 为减少连接创建开销的连接池，定义在 mosn.io/layotto/components/rpc/invoker/mosn/channel/connpool.go - hc.pool = newConnPool( - config.Size, - // dialFunc - func() (net.Conn, error) { - _, _, err := net.SplitHostPort(config.Listener) - if err == nil { - return net.Dial("tcp", config.Listener) - } - //创建一对虚拟连接(net.Pipe)，Layotto 持有 local，Mosn 持有 remote, Layotto 向 local 写入，Mosn 会收到数据, Mosn 从 remote读取，执行 filter 逻辑并进行代理转发，再将响应写到 remote ,最后 Layotto 从 remote 读取，获得响应 - local, remote := net.Pipe() - localTcpConn := &fakeTcpConn{c: local} - remoteTcpConn := &fakeTcpConn{c: remote} - // acceptFunc 是定义在 mosn.io/layotto/components/rpc/invoker/mosn/channel.go 中的闭包，闭包中监听了 remote 虚拟连接 - if err := acceptFunc(remoteTcpConn, config.Listener); err != nil { - return nil, err - } - // the goroutine model is: - // request goroutine ---> localTcpConn ---> mosn - // ^ | - // | | - // | | - // hstate <-- readloop goroutine <------ - return localTcpConn, nil - }, - // stateFunc - func() interface{} { - // hstate 是 readloop 协程与 request 协程通信的管道，是一对读写 net.Conn，请求协程从 reader net.Conn 中读数据，readloop 协程序往 writer net.Conn 写数据 - s := &hstate{} - s.reader, s.writer = net.Pipe() - return s - }, - hc.onData, - hc.cleanup, - ) - return hc, nil -} -``` - -### 0x05 Mosn read Remote and execute Filter and proxy forwarding - -(1) Similar to 0x02, filtermanager executes the filter processing phase where proxy forwarding is made in proxy with the following code. - -```go -... -mosn.io/mosn/pkg/network.(*filterManager).onContinueReading at filtermanager.go -=> -mosn.io/mosn/pkg/proxy.(*proxy).OnData at proxy.go -func (p *proxy) OnData(buf buffer.IoBuffer) api.FilterStatus { - if p.fallback { - return api.Continue - } - - if p.serverStreamConn == nil { - ... - p.serverStreamConn = stream.CreateServerStreamConnection(p.context, proto, p.readCallbacks.Connection(), p) - } - //把数据分发到对应协议的解码器，在这里因为是 POST /org.apache.dubbo.samples.UserProvider HTTP/1.1，所以是 mosn.io/mosn/pkg/stream/http.(*serverStreamConnection).serve at stream.go - p.serverStreamConn.Dispatch(buf) - - return api.Stop -} -=> -``` - -(2) ServerStreamConnection.serve listens and handles requests to downstream OnReceive, as described below. - -```go -mosn.io/mosn/pkg/stream/http.(*serverStream).handleRequest at stream.go -func (s *serverStream) handleRequest(ctx context.Context) { - if s.request != nil { - // set non-header info in request-line, like method, uri - injectCtxVarFromProtocolHeaders(ctx, s.header, s.request.URI()) - hasData := true - if len(s.request.Body()) == 0 { - hasData = false - } - - if hasData { - //在此进入 downstream OnReceive - s.receiver.OnReceive(s.ctx, s.header, buffer.NewIoBufferBytes(s.request.Body()), nil) - } else { - s.receiver.OnReceive(s.ctx, s.header, nil, nil) - } - } -} -=> -mosn.io/mosn/pkg/proxy.(*downStream).OnReceive at downstream.go -func (s *downStream) OnReceive(ctx context.Context, headers types.HeaderMap, data types.IoBuffer, trailers types.HeaderMap) { - ... - var task = func() { - ... - - phase := types.InitPhase - for i := 0; i < 10; i++ { - s.cleanNotify() - - phase = s.receive(s.context, id, phase) - ... - } - } - } - - if s.proxy.serverStreamConn.EnableWorkerPool() { - if s.proxy.workerpool != nil { - // use the worker pool for current proxy - s.proxy.workerpool.Schedule(task) - } else { - // use the global shared worker pool - pool.ScheduleAuto(task) - } - return - } - - task() - return - -} -``` - -(3) The above ScheduleAuto schedule, after processing the reveive of downstream Stream, processing upstam Request, as well as an application with an application from the network layer, eventually sending data from connection.Write and entering WaitNotify phases, as detailed below. - -```go -mosn.io/mosn/pkg/sync.(*workerPool).ScheduleAuto at workerpool.go -=> -mosn.io/mosn/pkg/sync.(*workerPool).spawnWorker at workerpool.go -=> -mosn.io/mosn/pkg/proxy.(*downStream).receive at downstream.go -=> -InitPhase=>DownFilter=>MatchRoute=>DownFilterAfterRoute=>ChooseHost=>DownFilterAfterChooseHost=>DownRecvHeader=>DownRecvData -=> -mosn.io/mosn/pkg/proxy.(*downStream).receiveData at downstream.go -=> -mosn.io/mosn/pkg/proxy.(*upstreamRequest).appendData at upstream.go -=> -mosn.io/mosn/pkg/stream/http.(*clientStream).doSend at stream.go -=> -github.com/valyala/fasthttp.(*Request).WriteTo at http.go -=> -mosn.io/mosn/pkg/stream/http.(*streamConnection).Write at stream.go -> -mosn.io/mosn/pkg/network.(*connection).Write at connection.go -=> -mosn.io/mosn/pkg/proxy.(*downStream).receive at downstream.go -func (s *downStream) receive(ctx context.Context, id uint32, phase types.Phase) types.Phase { - for i := 0; i <= int(types.End-types.InitPhase); i++ { - s.phase = phase - - switch phase { - ... - case types.WaitNotify: - s.printPhaseInfo(phase, id) - if p, err := s.waitNotify(id); err != nil { - return p - } - - if log.Proxy.GetLogLevel() >= log.DEBUG { - log.Proxy.Debugf(s.context, "[proxy] [downstream] OnReceive send downstream response %+v", s.downstreamRespHeaders) - } - ... -} -=> -func (s *downStream) waitNotify(id uint32) (phase types.Phase, err error) { - if atomic.LoadUint32(&s.ID) != id { - return types.End, types.ErrExit - } - - if log.Proxy.GetLogLevel() >= log.DEBUG { - log.Proxy.Debugf(s.context, "[proxy] [downstream] waitNotify begin %p, proxyId = %d", s, s.ID) - } - select { - // 阻塞等待 - case <-s.notify: - } - return s.processError(id) -} -``` - -### 0x06 Dubbo-go-sample server received request return response - -Here is a dubo-go-sample server handling, leave it now, post log messages and check the source code by interested classes. - -``` -[2022-04-18/21:03:03:18 github.com/apache/dub-go-samples/rpc/jsonrpc/go-server/pkg.(*UserProvider2).GetUser: user_provider2.go: 53] userID: "A003" -[2022-04-18/21:03:18 github.com/apache/dub-go-samples/rpc/jsonrpc/go-server/pkg. (*UserProvider2).GetUser: user_provider2.go: 56] rsp:&pkg.User{ID:"113", Name:"Moorse", Age:30, sex:0, Birth:703391943, Sex:"MAN"MAN"} -``` - -### 0x07 Mosn framework handles responses and writes back to Remote Virtual Connection - -After the third phase of 0x05 above, the response logic goes into the UpRecvData phase of the reveive cycle phase through a series of final response writing back to the remote virtual connection at 0x04, as follows. - -```go -mosn.io/mosn/pkg/proxy.(*downStream).receive at downstream.go -func (s *downStream) waitNotify(id uint32) (phase types.Phase, err error) { - if atomic.LoadUint32(&s.ID) != id { - return types.End, types.ErrExit - } - - if log.Proxy.GetLogLevel() >= log.DEBUG { - log.Proxy.Debugf(s.context, "[proxy] [downstream] waitNotify begin %p, proxyId = %d", s, s.ID) - } - // 返回响应 - select { - case <-s.notify: - } - return s.processError(id) -} -=> -UpFilter -=> -UpRecvHeader -=> -func (s *downStream) receive(ctx context.Context, id uint32, phase types.Phase) types.Phase { - for i := 0; i <= int(types.End-types.InitPhase); i++ { - s.phase = phase - - switch phase { - ... - case types.UpRecvData: - if s.downstreamRespDataBuf != nil { - s.printPhaseInfo(phase, id) - s.upstreamRequest.receiveData(s.downstreamRespTrailers == nil) - if p, err := s.processError(id); err != nil { - return p - } - } - ... -} -=> -mosn.io/mosn/pkg/proxy.(*upstreamRequest).receiveData at upstream.go -=> -mosn.io/mosn/pkg/proxy.(*downStream).onUpstreamData at downstream.go -=> -mosn.io/mosn/pkg/proxy.(*downStream).appendData at downstream.go -=> -mosn.io/mosn/pkg/stream/http.(*serverStream).AppendData at stream.go -=> -mosn.io/mosn/pkg/stream/http.(*serverStream).endStream at stream.go -=> -mosn.io/mosn/pkg/stream/http.(*serverStream).doSend at stream.go -=> -github.com/valyala/fasthttp.(*Response).WriteTo at http.go -=> -github.com/valyala/fasthttp.writeBufio at http.go -=> -github.com/valyala/fasthttp.(*statsWriter).Write at http.go -=> -mosn.io/mosn/pkg/stream/http.(*streamConnection).Write at stream.go -``` - -### 0x08 Layotto receive RPC responses and read Local Virtual Connection - -Readloop Reading IO, activated by 0x04 above, is activated from connection read data from Mosn and then forwarded to the hstate pipe to return to the request process, as follows. - -```go -mosn.io/layotto/components/rpc/invoker/mosn/channel.(*connPool).readloop at connpool.go -// readloop is loop to read connected then exec onDataFunc -func (p *connPool) readloop(c *wrapConn) { - var err error - - defer func() { - c.close() - if p.cleanupFunc != nil { - p.cleanupFunc(c, err) - } - }() - - c.buf = buffer.NewIoBuffer(defaultBufSize) - for { - // 从连接读取数据 - n, readErr := c.buf.ReadOnce(c) - if readErr != nil { - err = readErr - if readErr == io.EOF { - log.DefaultLogger.Debugf("[runtime][rpc]connpool readloop err: %s", readErr.Error()) - } else { - log.DefaultLogger.Errorf("[runtime][rpc]connpool readloop err: %s", readErr.Error()) - } - } - - if n > 0 { - // 在onDataFunc 委托给 hstate 处理数据 - if onDataErr := p.onDataFunc(c); onDataErr != nil { - err = onDataErr - log.DefaultLogger.Errorf("[runtime][rpc]connpool onData err: %s", onDataErr.Error()) - } - } - - if err != nil { - break - } - - if c.buf != nil && c.buf.Len() == 0 && c.buf.Cap() > maxBufSize { - c.buf.Free() - c.buf.Alloc(defaultBufSize) - } - } -} -=> -mosn.io/layotto/components/rpc/invoker/mosn/channel.(*httpChannel).onData at httpchannel.go -=> -mosn.io/layotto/components/rpc/invoker/mosn/channel.(*hstate).onData at httpchannel.go -=> -net.(*pipe).Write at pipe.go -=> -mosn.io/layotto/components/rpc/invoker/mosn/channel.(*httpChannel).Do at httpchannel.go -func (h *httpChannel) Do(req *rpc.RPCRequest) (*rpc.RPCResponse, error) { - ... - // 接上述0x04阶段，mosn 数据返回后，从 hstate 读取 readloop 协程从 mosn 返回的数据 - if err = httpResp.Read(bufio.NewReader(hstate.reader)); err != nil { - hstate.close() - h.pool.Put(conn, true) - return nil, common.Error(common.UnavailebleCode, err.Error()) - } - h.pool.Put(conn, false) - - // 获取 fasthttp 的数据部分，解析状态码，失败返回错误信息和状态码 - body := httpResp.Body() - if httpResp.StatusCode() != http.StatusOK { - return nil, common.Errorf(common.UnavailebleCode, "http response code %d, body: %s", httpResp.StatusCode(), string(body)) - } - - // 6. 将结果转换为 rpc.RPCResponse 返回 - rpcResp := &rpc.RPCResponse{ - ContentType: string(httpResp.Header.ContentType()), - Data: body, - Header: map[string][]string{}, - } - httpResp.Header.VisitAll(func(key, value []byte) { - rpcResp.Header[string(key)] = []string{string(value)} - }) - return rpcResp, nil -``` - -### 0x09 Grpc Sever processed data frames returned to clients - -Grpc does not write data directly to connections, but uses a systray loop to fetch frames from a cache structure and write them back to the client, as follows. - -```go -google.golang.org/grpc/internal/transport.NewServerTransport at http2_server.go -func NewServerTransport(conn net.Conn, config *ServerConfig) (_ ServerTransport, err error) { - ... - // 协程异步loop循环 - go func() { - t.loopy = newLoopyWriter(serverSide, t.framer, t.controlBuf, t.bdpEst) - t.loopy.ssGoAwayHandler = t.outgoingGoAwayHandler - if err := t.loopy.run(); err != nil { - if logger.V(logLevel) { - logger.Errorf("transport: loopyWriter.run returning. Err: %v", err) - } - } - t.conn.Close() - t.controlBuf.finish() - close(t.writerDone) - }() - go t.keepalive() - return t, nil -} -=> -google.golang.org/grpc/internal/transport.(*loopyWriter).run at controlbuf.go -=> -google.golang.org/grpc/internal/transport.(*bufWriter).Flush at http_util.go -=> -mosn.io/mosn/pkg/filter/network/grpc.(*Connection).Write at conn.go -=> -mosn.io/mosn/pkg/network.(*connection).Write at connection.go -=> -mosn.io/mosn/pkg/network.(*connection).writeDirectly at connection.go -=> -mosn.io/mosn/pkg/network.(*connection).doWrite at connection.go -``` - -### 0x10 dubbo-go-sample customer received response - -The transmission of data from 0x01 above will be blocked in the client grpc bottom reading, and Layotto returns data from some of the processing layers above to enable ClientBottom Read IO, as follows. - -```go -google.golang.org/grpc.(*ClientCon). Invoke at call.go -=> -google.golang.org/grpc.(*ClientCon). Invoke at call.go -=> -google.golang.org/grpc.(*clientStream). RecvMsg at stream. o -=> -google.golang.org/grpc.(*clientStream).withRetry at stream.go -=> -google.golang.org/grpc.(*csAtempt.recvMsg at stream.go -=> -google.golang.org/grpc.recvAndDecompress at rpc_util. o -=> -google.golang.org/grpc.recv at rpc_util.go -=> -google.golang.org/grpc.(*parser).recvMsg at rpc_util.go -=> -google.golang.org/grpc.(*csAttempt).recvMsg at stream. o -func (p *parser) recvMsg(maxReceiveMessageSize int) (pf payloadFormat, msg []byte, err error) LO - if _, err := p. .Read(p.header[:]); err != nil { - return 0, nil, err - } - ... -} -``` - -Last returned data： - -```json -{"jsonrpc": "2.0", "id":9527, "result":{"id":"113", "name":"Moorse", "age":30,"time":703394193,"sex":"MAN"}} -``` - -## Summary - -The Layotto RPC process involves knowledge related to GRPC, Dapr, Mosn and others, and the overall process is lengthy, although it is clearer and simpler simply to see Layotto for Mosn an abstract lightweight RPC framework and is more innovative and useful for further study.Here Layotto RPC requests are analyzed and time-limited without some more comprehensive and in-depth profiles, such as defects, welcome contact：rayo.wangzl@gmail.com.It is also hoped that there will be greater participation in source analysis and open source communities, learning together and making progress together. diff --git a/docs/i18n/en-US/docusaurus-plugin-content-blog/code/start_process/start_process.md b/docs/i18n/en-US/docusaurus-plugin-content-blog/code/start_process/start_process.md deleted file mode 100644 index 83225298ac..0000000000 --- a/docs/i18n/en-US/docusaurus-plugin-content-blog/code/start_process/start_process.md +++ /dev/null @@ -1,291 +0,0 @@ -# Source parsing layotto startup process - -> Author Intro to： -> Libin, https://github.com/ZLBer -> -> Writing: 4 May 2022 - -- [Overview](#Overview) -- [source analysis](#source analysis) - - [1.cmd analysis](#1.cmd analysis) - - [2.Callback functionNewRuntimeGrpcServer分析](#2.callback function NewRuntimeGrpcServer analysis) - - [3.runtimeanalyze](#3.runtime analyse) -- [summary](#summary) - -## Overview - -Layotto "Parasite" in MOSN. The start process is in effect starting MOSN, MOSN back Layotto during startup to get Layotto start. - -## Source analysis - -Everything originating from our command line: layotto start -c `configpath` - -### 1.cmd analysis - -Main init function starts with： - -``` -func init() { - //将layotto的初始化函数传给mosn，让mosn启动的时候进行回调 - mgrpc.RegisterServerHandler("runtime", NewRuntimeGrpcServer) - .... -} -``` - -cmd action starts to execute： - -``` - Action: func(c *cli.Context) error { - app := mosn.NewMosn() - //stagemanager用于管理mosn启动的每个阶段，可以添加相应的阶段函数，比如下面的ParamsParsedStage、InitStage、PreStartStage、AfterStartStage - //这里是将configpath传给mosn，下面都是mosn相关的逻辑 - stm := stagemanager.InitStageManager(c, c.String("config"), app) - stm.AppendParamsParsedStage(ExtensionsRegister) - stm.AppendParamsParsedStage(func(c *cli.Context) { - err := featuregate.Set(c.String("feature-gates")) - if err != nil { - os.Exit(1) - } - })· - stm.AppendInitStage(mosn.DefaultInitStage) - stm.AppendPreStartStage(mosn.DefaultPreStartStage) - stm.AppendStartStage(mosn.DefaultStartStage) - //这里添加layotto的健康检查机制 - stm.AppendAfterStartStage(SetActuatorAfterStart) - stm.Run() - // wait mosn finished - stm.WaitFinish() - return nil - }, -``` - -### NewRuntimeGrpcServer Analysis - -Returns NewRuntimeGrpcServer when MOSN is launched, data is an unparsed configuration, opts is a grpc configuration, returning Gpc server - -``` -func NewRuntimeGrpcServer(data json.RawMessage, opts ...grpc.ServerOption) (mgrpc.RegisteredServer, error) { - // 将原始的配置文件解析成结构体形式。 - cfg, err := runtime.ParseRuntimeConfig(data) - // 新建layotto runtime， runtime包含各种组件的注册器和各种组件的实例。 - rt := runtime.NewMosnRuntime(cfg) - // 3.runtime开始启动 - server, err := rt.Run( - ... - // 4. 添加所有组件的初始化函数 - // 我们只看下File组件的，将NewXXX()添加到组件Factory里 - runtime.WithFileFactory( - file.NewFileFactory("aliyun.oss", alicloud.NewAliCloudOSS), - file.NewFileFactory("minio", minio.NewMinioOss), - file.NewFileFactory("aws.s3", aws.NewAwsOss), - file.NewFileFactory("tencent.oss", tencentcloud.NewTencentCloudOSS), - file.NewFileFactory("local", local.NewLocalStore), - file.NewFileFactory("qiniu.oss", qiniu.NewQiniuOSS), - ), - ... - return server, err - - ) - - // -} - -``` - -### runtime analysis - -Look at the structure of runtime, the composition of the `runtime' at the aggregate level of the`：' - -``` -type MosnRuntime struct { - // 包括组件的config - runtimeConfig *MosnRuntimeConfig - info *info.RuntimeInfo - srv mgrpc.RegisteredServer - // 组件注册器，用来注册和新建组件，里面有组件的NewXXX()函数 - helloRegistry hello.Registry - configStoreRegistry configstores.Registry - rpcRegistry rpc.Registry - pubSubRegistry runtime_pubsub.Registry - stateRegistry runtime_state.Registry - lockRegistry runtime_lock.Registry - sequencerRegistry runtime_sequencer.Registry - fileRegistry file.Registry - bindingsRegistry mbindings.Registry - secretStoresRegistry msecretstores.Registry - customComponentRegistry custom.Registry - hellos map[string]hello.HelloService - // 各种组件 - configStores map[string]configstores.Store - rpcs map[string]rpc.Invoker - pubSubs map[string]pubsub.PubSub - states map[string]state.Store - files map[string]file.File - locks map[string]lock.LockStore - sequencers map[string]sequencer.Store - outputBindings map[string]bindings.OutputBinding - secretStores map[string]secretstores.SecretStore - customComponent map[string]map[string]custom.Component - AppCallbackConn *rawGRPC.ClientConn - errInt ErrInterceptor - started bool - //初始化函数 - initRuntimeStages []initRuntimeStage -} -``` - -runtime is the run function logic as follows: - -``` -func (m *MosnRuntime) Run(opts..Option) (mgrpc.RegisteredServer, error) um - // launch flag - m. targeted = true - // newly created runtime configuration - o := newRuntimeOptions() - // run our previously imported option,. Really register various components Factory with - for _, opt := range opts { - opt(o) - } - //initialization component - if err := m. nitRuntime(o); err != nil { - return nil, err - } - - //initialize Grpc,api assignment - var grpcOpts[]grpc. Absorption - if o.srvMaker != nil LO - grpcOpts = append(grpcOpts, grpc.GithNewServer(o.srvMaker)) - } - var apis []grpc.GrpcAPI - ac := &grpc. pimplicationContextFe - m.runtimeConfig.AppManagement.AppId, - m.hellos, - m.configStories, - m.rpcs, - m.pubSubs, - m. tates, - m.files, - m.locks, - m.sequencers, - m.sendToOutputBinding, - m.secretStories, - m. ustomCompany, - } - // Factor generation of each component - for _, apiFactory := range o. piFactorys LOR - api := apiFactory(ac) - // init the GrpcAPI - if err := api.Init(m. ppCallbackCon); err != nil { - return nil, err - } - apis = append(apis, api) - } - // pass the api interface and configuration to grpc - grpcOpts = append(grpcOpts, - grpc.GrpOptions(o.options... , - grpc.MithGrpcAPIs(apis), - ) - //start grpc - var err error = nil - m. rv, err = grpc.NewGrpServer (grpcOpts...) - return m.srv, err -} - -``` - -Component initialization function initRuntime ： - -``` -func (m *MosnRuntime) initRuntime (r *runtimeOptions) errant error LO - st := time.Now() - if len(m.initRuntimeStages) === 0 56 - m.initRuntimeStages = append(m. nitRuntimeStages, DefaultInitRuntimeStage - } - // Call DefaultInitRuntimeStage - for _, f := range m. nitRuntime Stages FEM - err := f(r, m) - if err != nil { - return err - } - } - . . - return nil -} -``` - -DefaultInitRuntimeStage component initialization logic, call init method for each component: - -``` -func DefaultInitRuntimeStage(o *runtimeOptions, m *MosnRuntime) error { - ... - //初始化config/state/file/lock/sequencer/secret等各种组件 - if err := m.initCustomComponents(o.services.custom); err != nil { - return err - } - if err := m.initHellos(o.services.hellos...); err != nil { - return err - } - if err := m.initConfigStores(o.services.configStores...); err != nil { - return err - } - if err := m.initStates(o.services.states...); err != nil { - return err - } - if err := m.initRpcs(o.services.rpcs...); err != nil { - return err - } - if err := m.initOutputBinding(o.services.outputBinding...); err != nil { - return err - } - if err := m.initPubSubs(o.services.pubSubs...); err != nil { - return err - } - if err := m.initFiles(o.services.files...); err != nil { - return err - } - if err := m.initLocks(o.services.locks...); err != nil { - return err - } - if err := m.initSequencers(o.services.sequencers...); err != nil { - return err - } - if err := m.initInputBinding(o.services.inputBinding...); err != nil { - return err - } - if err := m.initSecretStores(o.services.secretStores...); err != nil { - return err - } - return nil -} -``` - -Example file component, see initialization function： - -``` -func (m *MosnRuntime) initFiles(files ...file.FileFactory) ERRORY ERROR LO - - //register configured components on - m.fileRegistry.Register(files...) - for name, config := range m. untimesConfig.Files Fact - //create/create a new component instance - c, err := m.fileRegistry.Create(name) - if err !=nil L/ - m. rrInt(err, "creation files component %s failed", name) - return err - } - if err := c. nit(context.TODO(), &config); err != nil LO - m. rrInt(err, "init files component %s failed", name) - return err - } - //assignment to runtime - m. files[name] = c - } - return nil -} -``` - -Here MOSN, Grpc and Layotto are all started, and the code logic of the component can be called through the Gypc interface. - -## Summary - -Overall view of the entire startup process, Layotto integration with MOSN to start, parse configuration files, generate component classes in the configuration file and expose the api of Grpc. diff --git a/docs/i18n/en-US/docusaurus-plugin-content-blog/code/webassembly/index.md b/docs/i18n/en-US/docusaurus-plugin-content-blog/code/webassembly/index.md deleted file mode 100644 index 6953d27192..0000000000 --- a/docs/i18n/en-US/docusaurus-plugin-content-blog/code/webassembly/index.md +++ /dev/null @@ -1,634 +0,0 @@ -# Layotto Source Parsing — WebAssembly - -> This paper mainly analyses the relevant implementation and application of Layotto Middle WASM. -> -> by：[Wang Zhilong](https://github.com/rayowang) | 18 May 2022 - -- [overview](#overview) -- [source analysis](#source analysis) - - [Frame INIT](#Frame INIT) - - [workflow](#workflow) - - [FaaSmode](#FaaS mode) -- [summary](#summary) - -## General description - -WebAssemly Abbreviations WASM, a portable, small and loaded binary format operating in sandboxing implementation environment, was originally designed to achieve high-performance applications in web browsers, benefiting from its good segregation and security, multilingual support, cool-start fast flexibility and agility and application to embed other applications for better expansion, and obviously we can embed it into Layotto.Layotto supports loading compiled WASM files and interacting with the Target WASM API via proxy_abi_version_0_2_0; -other Layotto also supports loading and running WASM carrier functions and supports interfaces between Function and access to infrastructure; and Layotto communities are also exploring the compilation of components into WASM modules to increase segregation between modules.This article uses the Layotto official [quickstart](https://mosn.io/layotto/#/zh/start/wasm/start) example of accessing redis as an example to analyze WebAssemly in Layotto Related implementation and application. - -## Source analysis - -Note：is based on commit hash：f1cf350a52b5a1a0b3788a31681007a056e332ef - -### Frame INIT - -As the bottom layer of Layotto is Mosn, the WASM extension framework is also the WASM extension framework that reuses Mosn, as shown in figure 1 Layotto & Mosn WASM framework [1]. - - - -
-
-[](https://github.com/mosn/layotto/actions/workflows/proto-checker.yml)
-[](https://github.com/mosn/layotto/actions/workflows/layotto-ci.yml)
-
-[](https://godoc.org/mosn.io/layotto)
-[](https://goreportcard.com/report/mosn.io/layotto)
-[](https://codecov.io/gh/mosn/layotto)
-[](http://isitmaintained.com/project/mosn/layotto "Average time to resolve an issue")
-
-
-Layotto(/leɪˈɒtəʊ/) is an application runtime developed using Golang, which provides various distributed capabilities for applications, such as state management, configuration management, and event pub/sub capabilities to simplify application development.
-
-Layotto is built on the open source data plane [MOSN](https://github.com/mosn/mosn) .In addition to providing distributed building blocks, Layotto can also serve as the data plane of Service Mesh and has the ability to control traffic.
-
-## Motivation
-
-Layotto aims to combine [Multi-Runtime](https://www.infoq.com/articles/multi-runtime-microservice-architecture/) with Service Mesh into one sidecar. No matter which product you are using as the Service Mesh data plane (e.g. MOSN,Envoy or any other product), you can always attach Layotto to it and add Multi-Runtime capabilities without adding new sidecars.
-
-For example, by adding Runtime capabilities to MOSN, a Layotto process can both [serve as the data plane of istio](start/istio/) and provide various Runtime APIs (such as Configuration API, Pub/Sub API, etc.)
-
-In addition, we were surprised to find that a sidecar can do much more than that. We are trying to make Layotto even the runtime container of FaaS (Function as a service) with the magic power of [WebAssembly](https://en.wikipedia.org/wiki/WebAssembly) .
-
-## Features
-
-- Service Communication
-- Service Governance.Such as traffic hijacking and observation, service rate limiting, etc
-- [As the data plane of istio](start/istio/)
-- Configuration management
-- State management
-- Event publish and subscribe
-- Health check, query runtime metadata
-- Multilingual programming based on WASM
-
-## Project Architecture
-
-As shown in the architecture diagram below, Layotto uses the open source MOSN as the base to provide network layer management capabilities while providing distributed capabilities. The business logic can directly interact with Layotto through a lightweight SDK without paying attention to the specific back-end infrastructure.
-
-Layotto provides sdk in various languages. The sdk interacts with Layotto through grpc. Application developers only need to specify their own infrastructure type through the [configuration file](https://github.com/mosn/layotto/blob/main/configs/runtime_config.json) provided by Layotto. No coding changes are required, which greatly improves the portability of the program.
-
-
-
-## Quickstarts
-
-### Get started with Layotto
-
-You can try the quickstart demos below to get started with Layotto. In addition, you can experience the [online laboratory](start/lab.md)
-
-### API
-
-| API | status | quick start | desc |
-| -------------- | :----: | :-------------------------------------------------------------------: | -------------------------------------------------------------- |
-| State | ✅ | [demo](https://mosn.io/layotto/#/en/start/state/start) | Write/Query the data of the Key/Value model |
-| Pub/Sub | ✅ | [demo](https://mosn.io/layotto/#/en/start/pubsub/start) | Publish/Subscribe message through various Message Queue |
-| Service Invoke | ✅ | [demo](https://mosn.io/layotto/#/en/start/rpc/helloworld) | Call Service through MOSN (another istio data plane) |
-| Config | ✅ | [demo](https://mosn.io/layotto/#/en/start/configuration/start-apollo) | Write/Query/Subscribe the config through various Config Center |
-| Lock | ✅ | [demo](https://mosn.io/layotto/#/en/start/lock/start) | Distributed lock API |
-| Sequencer | ✅ | [demo](https://mosn.io/layotto/#/en/start/sequencer/start) | Generate distributed unique and incremental ID |
-| File | ✅ | TODO | File API implementation |
-| Binding | ✅ | TODO | Transparent data transmission API |
-
-
-### Service Mesh
-
-| feature | status | quick start | desc |
-| ------- | :----: |:----------------------------:| -------------------------- |
-| istio | ✅ | [demo](start/istio/start.md) | As the data plane of istio |
-
-### Extendability
-
-| feature | status | quick start | desc |
-| ---------- | :----: | :--------------------------------------------------------------: | -------------------------- |
-| API plugin | ✅ | [demo](https://mosn.io/layotto/#/en/start/api_plugin/helloworld) | You can add your own API ! |
-
-### Actuator
-
-| feature | status | quick start | desc |
-| -------------- | :----: | :-------------------------------------------------------: | --------------------------------------------------- |
-| Health Check | ✅ | [demo](https://mosn.io/layotto/#/en/start/actuator/start) | Query health state of app and components in Layotto |
-| Metadata Query | ✅ | [demo](https://mosn.io/layotto/#/en/start/actuator/start) | Query metadata in Layotto/app |
-
-### Traffic Control
-
-| feature | status | quick start | desc |
-| ------------ | :----: | :-------------------------------------------------------------------: | --------------------------------------------------------------- |
-| TCP Copy | ✅ | [demo](https://mosn.io/layotto/#/en/start/network_filter/tcpcopy) | Dump the tcp traffic received by Layotto into local file system |
-| Flow Control | ✅ | [demo](https://mosn.io/layotto/#/en/start/stream_filter/flow_control) | limit access to the APIs provided by Layotto |
-
-### Write your bussiness logic using WASM
-
-| feature | status | quick start | desc |
-| -------------- | :----: | :---------------------------------------------------: | -------------------------------------------------------------------- |
-| Go (TinyGo) | ✅ | [demo](https://mosn.io/layotto/#/en/start/wasm/start) | Compile Code written by TinyGo to \*.wasm and run in Layotto |
-| Rust | ✅ | [demo](https://mosn.io/layotto/#/en/start/wasm/start) | Compile Code written by Rust to \*.wasm and run in Layotto |
-| AssemblyScript | ✅ | [demo](https://mosn.io/layotto/#/en/start/wasm/start) | Compile Code written by AssemblyScript to \*.wasm and run in Layotto |
-
-### As a FaaS(Serverless) runtime (Layotto + WebAssembly + k8s)
-
-| feature | status | quick start | desc |
-| -------------- | :----: | :---------------------------------------------------: | ------------------------------------------------------------------------------------------ |
-| Go (TinyGo) | ✅ | [demo](https://mosn.io/layotto/#/en/start/faas/start) | Compile Code written by TinyGo to \*.wasm and run in Layotto And Scheduled by k8s. |
-| Rust | ✅ | [demo](https://mosn.io/layotto/#/en/start/faas/start) | Compile Code written by Rust to \*.wasm and run in Layotto And Scheduled by k8s. |
-| AssemblyScript | ✅ | [demo](https://mosn.io/layotto/#/en/start/faas/start) | Compile Code written by AssemblyScript to \*.wasm and run in Layotto And Scheduled by k8s. |
-
-## Presentations
-
-- [Layotto - A new chapter of Service Mesh and Application Runtime](https://www.youtube.com/watch?v=5v8gTrFUDk8)
-- [WebAssembly + Application Runtime = A New Era of FaaS?](https://www.youtube.com/watch?v=g01CJ4S9Qao)
-
-## Landscapes
-
-
-
-
-Layotto enriches the CNCF CLOUD NATIVE Landscape.
-
|
-
-[comment]: <> (| 💬 [Wechat](https://www.wechat.com/en/) | Scan the QR code below and she will invite you into the wechat group )
-
-## How to contribute
-
-[Where to start? Check "Community tasks" list!](https://github.com/mosn/layotto/issues/108)
-
-As a programming enthusiast , have you ever felt that you want to participate in the development of an open source project, but don't know where to start?
-In order to help everyone better participate in open source projects, our community will regularly publish community tasks to help everyone learn by doing!
-
-[Document Contribution Guide](development/contributing-doc.md)
-
-[Component Development Guide](development/developing-component.md)
-
-[Layotto Github Workflows](development/github-workflows.md)
-
-[Layotto Commands Guide](development/commands.md)
-
-[Layotto contributor guide](development/CONTRIBUTING.md)
-
-## Contributors
-
-Thank y'all!
-
-
- 
-
-#### step 1. Write implementation for the API just defined
-
-The protoc compiler will help you compile the interface `hellotorld.GreeterServer`, based on proto file, but the interface needs to be translated by itself.
-
-For example, the `server` we wrote in the example implements `helloworl.GreeterServer` interface, with `Sayhello` method:
-
-```go
-//server is used to implement elllowld.GreeterServer.
-type server struct LO
- appId strating
- // custom-components which implement the `HelloWorld` interface
- name2component map[string]component. World
- // LockStore components. They are not used in this demo, we put them here as a demo.
- name2LockStore map[string]block. ockStore
- pb.UnimplementedGreeterServer
-}
-
-// Sayhello implements hellowd. reeterServer.Sayhello
-func (s *server) SayHello(ctx context.Context, in *pb.HelloRequest) (*pb.HelloReply, error) 6
- if _, ok := s.name2component[componentName]; !ok $6
- return &pb. elloReply{Message: "We don't want to talk with you!"}, nil
- }
- message, err := s.name2component[componentName]. ayHello(in.GetName()
- if err != nil {
- return nil, err
- }
- return &pb.HelloReply{Message: message}, nil
-}
-```
-
-#### Step 2. Implement [`GrpcAPI` interface](https://github.com/mosn/layotto/blob/main/pkg/grpc/grpc_api.go), manage the life cycle of API plugins
-
-Now that you have your own API implementation, you need to register it on Layotto next step.
-
-> **Rememberly**：How to register the API on the original grpc server?
->
-> Just write this line of code：
->
-> pb.RegisterGreeterServer (s, &server{})
-
-To register your API on Layotto,：
-
-- Implementing [`GrpcAPI` interface](https://github.com/mosn/layotto/blob/main/pkg/grpc/grpc_api.go), implementing some lifecycle hooks
-
-This GrpcAPI manages your API lifecycle and provides various life cycle hooks.There are currently Init and Register in the current lifecycle hook.
-
-```go
-// GrpcAPI is the interface of API plugin. It has lifecycle related methods
-type GrpcAPI interface of the APIs
- // init this API before binding it to the grpc server.
- // For example, you can call the app to every their subscriptions.
- Init (conn *grpc. lientConn) error
-
- // Bind this API to the grpc server
- Register(s *grpc. erver, registeredServer mgrp.RegisteredServer) (mgrpc.RegisteredServer, error)
-}
-```
-
-- Performs the corresponding constructor `NewGrpcAPI` to create your `GrpcAPI`.
-
-```go
-// NewGrpcAPI is the constructor of GpcAPI
-type NewGrpcAPI func (applicationContext *ApplicationContext) GrpcAPI
-```
-
-`*ApplicationContext` is defined as：
-
-```go
-// ApplicationContext contains all you need to construct your GrpcAPI, such as all the components.
-// For example, your `SuperState` GrpcAPI can hold the `StateStores` components and use them to implement your own `Super State API` logic.
-type ApplicationContext struct {
- AppId string
- Hellos map[string]hello.HelloService
- ConfigStores map[string]configstores.Store
- Rpcs map[string]rpc.Invoker
- PubSubs map[string]pubsub.PubSub
- StateStores map[string]state.Store
- Files map[string]file.File
- LockStores map[string]lock.LockStore
- Sequencers map[string]sequencer.Store
- SendToOutputBindingFn func(name string, req *bindings.InvokeRequest) (*bindings.InvokeResponse, error)
- SecretStores map[string]secretstores.SecretStore
- CustomComponent map[string]map[string]custom.Component
-}
-```
-
-##### What is the interpretation of：`CustomComponent`?
-
-is "Custom components".
-
-Component in Layotto is divided into prime mill：
-
-- Preset Component
-
-e.g. `pubsub` components, like `state` component
-
-- Custom Component
-
-Allows you to expand your own components, such as the `HelloWorld` component in the example below.
-
-##### How does：configure a custom component?
-
-See[自定义组件的配置文档](component_specs/custom/common.md)
-
-##### View Example
-
-Look at a specific example, in [helloowold exams](https://github.com/mosn/layotto/blob/main/cmd/layotto_multiple_api/helloworld/grpc_api.go), `*server` implements `Init`
-and `Register`:
-
-```go
-func (s *server) Init (conn *rawGRPC.ClientConn) error {
- return nil
-}
-
-func (s *server) Register(grpcServer *rawGRPC.Server, registeredServer mgrpc. egisteredServer) (mgrpc.RegisteredServer, error) um
- pb.RegisterGreeterServer (GrpcServer, s)
- return registeredServer, nil
-}
-```
-
-There is also a construction:
-
-```go
-func NewHelloWorldAPI(ac *grpc_api.ApplicationContext) grpc.GrpcAPI
- // 1. convert custom-components components
- name2component := make(map[string]component. elloWorld)
- if len(ac.CustomComponent) != 0 56
- /we only care about those components of type "helloowl"
- name2comp, ok := ac. customomComponent[kind]
- if ok & len (name2comp) > 0 F6
- for name, ::= range name2comp LO
- // convert them using type assortion
- comp, ok := v. component.HelloWorld)
- if !ok
- errMsg := fmt. printf("customom component %s does not implement HelloWorld interface", name)
- log.DefaultLogger. rorf(errMsg)
- }
- name2component[name] = comp
- }
- }
- }
- / 2. Construct your API implementation
- return &server
- appId: ac. ppId,
- // Your API plugins in can store and use all the components.
- // For example, this demand set all the LockStore components here.
- name2LockStore: ac.LockStories,
- // Customers components of type "helloorl"
- name2component: name2component,
- }
-}
-```
-
-##### Explain：these callbacks, constructions?
-
-Look at this example, you might ask：these callbacks, constructions and calls?
-
-The hook above is used to customize the start logic for the user extension.Layotto reverses the above life-cycle hooks and constructions during startup.Call order roughly：
-
-`Layotto initialize all components` ---> Call `NewGrpcAPI` constructor ---> `GrpcAPI.Init` ---> ``Layotto create grpc server` --->``GrpcAPI.Register\`\`
-
-Graph below：
-
-
-
-#### step 3. Sign up your own API into Layotto
-
-After achieving your private API
-following the above steps, you can [register it in your main main in Layotto](https://github.com/mosn/layotto/blob/5234a80cdc97798162d03546eb8e0ee163c0ad60/cmd/layotto_multiple_api/main.go#L203):
-
-```go
-
-func NewRuntimeGrpcServer (data json.RawMessage, options..grpc.ServerOption) (mgrpc. egisteredServer, error) LO
- // ......
-
- /3. run
- server, err := rt. un(
- runtime.WithGrpcOptions(opts... ,
- // register your GrpcAPI here
- runtime. ithGrpcAPI(
- // default GrpcAPI
- default_api. ewGrpcAPI,
- // a demo to show how to register your own GrpcAPI
- helloord_api. ewHelloWorldAPI,
- ),
- // Hello
- runtime. ithHelloFactory (
- hello.NewHelloFactory ("hellotorld", hellold. ewHelloWorld),
- ),
- // ...
-```
-
-We recommend that users customize main functions and customize startup processes in their own projects.
-
-Specifically, you can paste the main copy of Layotto into your project, modify it as necessary, and remove something that is not available (e.g. in a distribution lock component that is not etcd, you can remove it from your main name)
-
-#### Step 4. Compile Run Layotto
-
-Ready to start Layotto.
-
-Example hellowd：
-
-```shell
-cd ${project_path}/cmd/layotto_multiple_api
-go build -o layotto
-# run it
-./layotto start -c ../../configs/config_standalone.json
-```
-
-During Layotto launch, each registered API lifecycle method (Init, Register) will be callback to each registered API
-
-Once startup, your API will offer grpc services externally
diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/design/configuration/configuration-api-with-apollo.md b/docs/i18n/en-US/docusaurus-plugin-content-docs/current/design/configuration/configuration-api-with-apollo.md
deleted file mode 100644
index 2bb3a5521f..0000000000
--- a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/design/configuration/configuration-api-with-apollo.md
+++ /dev/null
@@ -1,119 +0,0 @@
-# Implementing Configuration API with ctripcorp/apollo
-
-## Objective
-
-Implementation of [Configuration API(level-2)](https://github.com/dapr/dapr/issues/2988) with ctripcorp/apollo
-
-## Schema
-
-### Configuration API map apollo schema
-
-The mapping rules are as follows:
-
-| Configuration API Parameters | apollo schema |
-| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
-| app_id | ///ignore this parameter when searching for or subscribed to it, use app_id in configuration file instead |
-| Group | name |
-| label | //追加到key的后面. 在apollo中key实际存储的格式为'key@$label' |
-| tag | // Put an item in the configuration in json |
-
-在apollo中key实际存储的格式为`key@$label`，value为原始值。
-
-Tags将以key=`group@$key@$label` and value=
-
-```json
-LO
- "tag1": "tag1value",
- "tag2": "tag2value"
-}
-```
-
-Format is stored in a specific namespace `sidecar_config_tags`
-
-**Q: Why don't you have an item to store values and tags to reduce the number of queries, e.g. :**
-
-```json
-{
- "value":"raw value",
- "tags":{
- "tag1":"tag1value",
- "tag2":"tag2value"
- }
-}
-```
-
-A: If this design is adopted, the historical legacy of the use of apollo will not be able to migrate to sidecar
-
-### How to migrate historical legacy projects
-
-1. Get/subscripbe API is compatible.Without save/delete API, users can easily migrate legacy projects to sidecar.只需要在config.json文件中保持`label`字段为空，sidecar将会使用原始key来替代`key@$label`与apollo进行交互。
-2. Save/delete API may not be compatible.sidecar uses fixed `cluster` and `env` fields in config.json.This means that users cannot use `cluster` and `env` fields as parameters for save/deleteAPI if they want to change some configuration items with other appids.
-
-### sidecar config.json file
-
-```json
-{
- "config_store": {
- "type": "apollo",
- "address": [
- "http://106.54.227.205:8080"
- ],
- "metadata": {
- "app_id": "testApplication_yang",
- "cluster": "dev",
- "namespace_name": "dubbo,product.joe",
- "is_backup_config": true,
- "secret": "6ce3ff7e96a24335a9634fe9abca6d51"
- }
- }
-}
-```
-
-## API
-
-### Which Apollo SDK should I use?
-
-Currently using official maintenance[SDK](https://github.com/apolloconfig/agollo), other Apollo's third party SDK can be found from[链接](https://www.apolloconfig.com/#/usage/third-party-sdks-user-guide).
-
-Use some of this sdk's attention:
-
-1. Before connecting to the server and creating the client, the user must declare all namespace in the AppConfig, as shown below in：
-
-```go
- c := &config. ppConfigL
- AppID: "testApplication_yang",
- Cluster: "dev",
- IP: "http://106. 4.227. 05:8080",
- NamespaceName: "dubbo", // Statement
- IsBackupConfig: true,
- Secret: "6ce3ff7e96a24335a9634fe9abca6d51",
- }
- client, err := agolloConfig. tartWithConfig(func() (*config.AppConfig, error) {
- return c, nil
- })
-```
-
-1. You cannot configure the `env` field.
-
-2. No Save/delete API.
-
-3. No bulk queries for API.
-
-4. Security cannot be ensured in parallel.
-
-5. Configure or don't use [Apollo Meta Server](https://www.apollocconfig.com/#/usage/java-sdk-user-guide?id=_122-apollo-meta-server).
-
-6. There is a problem setting kv and tags. There is no transaction.
-
-### How I should use the Apollo SDK API
-
-| Configuration API | apollo sdk API |
-| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| GetConfiguration | cache := client.GetConfigCache(c.NamespaceName)value,_:= client.Get("key") |
-| SaveConfiguration | 通过http. [update](https://www.apolloconfig.com/#/zh/usage/apollo-open-api-platform?id=_3211-%e4%bf%ae%e6%94%b9%e9%85%8d%e7%bd%ae%e6%8e%a5%e5%8f%a3) + [commit](https://www.apolloconfig.com/#/zh/usage/apollo-open-api-platform?id=_3213-%e5%8f%91%e5%b8%83%e9%85%8d%e7%bd%ae%e6%8e%a5%e5%8f%a3) 使用open API |
-| DeleteConfiguration | 使用http. [delete](https://www.apolloconfig.com/#/zh/usage/apollo-open-api-platform?id=_3212-%e5%88%a0%e9%99%a4%e9%85%8d%e7%bd%ae%e6%8e%a5%e5%8f%a3) + [commit](https://www.apolloconfig.com/#/zh/usage/apollo-open-api-platform?id=_3213-%e5%8f%91%e5%b8%83%e9%85%8d%e7%bd%ae%e6%8e%a5%e5%8f%a3) 使用open API |
-| SubscripbeConfiguration | https://github.com/apolloconfig/agollo/wiki/%E7%9B%91%E5%90%AC%E5%8F%98%E6%9B%B4%E4%BA%8B%E4%BB%B6 |
-
-### How to subscribe to all configuration changes for the specified app
-
-Subscribe to all declared namespaces in config.json file.
diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/design/faas/faas-poc-design.md b/docs/i18n/en-US/docusaurus-plugin-content-docs/current/design/faas/faas-poc-design.md
deleted file mode 100644
index 743c8cb12e..0000000000
--- a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/design/faas/faas-poc-design.md
+++ /dev/null
@@ -1,45 +0,0 @@
-# FaaS Design Document
-
-## Structure design
-
-
-
-In the package FaaS, the following two issues were resolved mainly by the following question：
-
-1. What is the relationship between compiled waste files and mirrors?
- 1. The target waste file is eventually built into a normal mirror, pushed to Dockerhub. The pulse pulls the image as well as the original image. However, when running, the target waste file will be extracted from the image to load it separately.
-2. How can k8s be managed to deploy wasm documents?
- 1. Based on k8s' life-cycle management and movement strategy, the Containerd-shim-layotto-v2 plugins are customized in connection with Containerd's v2 interfaces and converted to Layotto Runtime when the container is running, for example, the k8s's creation of a container is turned into a function that loads the waste shape and runs.
- 2. A sandbox isolation environment with a good Web Assembly and Layotto as a base can load functions that run multiple wasm forms, all of which are running in a process but not influential, and this nanoprocity thinks more than a docker can make full use of resources.
-
-### Core components
-
-#### A, [WebAssembly (wasm)](https://webassembly.org/)
-
-Wasm1,wasm2 in the corresponding architectural charts, which codify and run the developed function as `*.wasm` as the form of function existing, using the sandbox isolation provided by WebAssembly technology for purposes that do not affect each function.
-
-#### B,[Layotto](https://github.com/mosn/layotto)
-
-Positions are designed to provide services, resources and security for functions.As a base from which functions will operate, provide access to the entrance to the infrastructure including WebAssembly running, functions can use maximum resource limits, functions for system call permission validation, etc.
-
-#### C,[Containerd](https://containerd.io/)
-
-When officially supported containers are running, docker is one of the most scenic implementations currently used, and security containers such as kata and gvisor are also using the technology and Layotto builds on their thinking and integrates the function loading process into concrete implementation when the container is running.
-
-#### D,[Containerd-shim-layotto-v2](https://github.com/layotto/containerd-wasm)
-
-Based on Containerd's V2 interface definition, the logic of the running of the container is customized, such as creating the container to perform the operation to allow Layotto load and run the wasm function.
-
-#### E,[Kubernetes](https://kubernetes.io/)
-
-The factual standard of the current container schedule, life-cycle management and movement strategy are excellent, and the containerd-based solution is designed to combine function movement with k8s ecologically perfect.
-
-### Runtime ABI
-
-#### A. [proxy-wasm-go-sdk](https://github.com/layotto/proxy-wasm-go-sdk)
-
-The interface of function access to system resources and infrastructure services is defined and implemented on a community-based basis [proxy-waste/spec] (https://github.com/proxy-wasm/spec) that brings together the [Runtime API](https://github.com/mosn/layotto/blob/main/spec/proto/runtime/v1/runtime.proto) and adds ABI to infrastructure visits.
-
-#### B. [proxy-wasm-go-host](https://github.com/layotto/proxy-wasm-go-host)
-
-Concrete logic for Runtime ABI in Layotto.
diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/design/file/file-design.md b/docs/i18n/en-US/docusaurus-plugin-content-docs/current/design/file/file-design.md
deleted file mode 100644
index 52e798a8d0..0000000000
--- a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/design/file/file-design.md
+++ /dev/null
@@ -1,123 +0,0 @@
-# File API design documentation
-
-## API
-
-The API definition is mainly based on commonly used file operations and is divided into four additional and deleted interfaces. For the Get/Put interface, file upload and download require support for streaming transfer.Thus the following interface definition is：
-
-```protobuf
- // Get file with stream
- rpc GetFile(GetFileRequest) returns (stream GetFileResponse) {}
-
- // Put file with stream
- rpc PutFile(stream PuteRequest) returns (google. Rotobuf. mpty) {}
-
- // List all files
- rpc ListFile(ListFileRequest) returns (ListFileResponse){}
-
- // Delete specific file
- rpc DelFile(DelFileRequest) returns (google. Rotobuf.Empty {}
-```
-
-Discussion of the definition of interfaces can be based on[issue98](https://github.com/mosn/layotto/issues/98)
-
-## Definition of parameters
-
-```protobuf
-message GetFileRequest {
- //
- string store_name = 1;
- // The name of the file or object want to get.
- string name = 2;
- // The metadata for user extension.
- map|[\S\n]*)?\[!(\w*)((?:\|[\w*:[\s\w\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF-]*)*?)\]([\s\S]*?)(?:<\/p>)?<\s*\/\s*blockquote>/g,function(t,e,a,l){!w[e.toLowerCase()]&&w.typeMappings[e.toLowerCase()]&&(e=w.typeMappings[e.toLowerCase()]);var o=w[e.toLowerCase()];if(!o)return t;var r,n=p(a,"style",w.style),i=p(a,"iconVisibility","visible",function(t){return"hidden"!==t}),c=p(a,"labelVisibility","visible",function(t){return"hidden"!==t}),d=p(a,"label",o.label),s=p(a,"icon",o.icon),g=p(a,"className",o.className);"object"===h(d)&&((r=Object.keys(d).filter(function(t){return-1 '.concat(i?m:"").concat(c?d:""," ").concat(l," {description} {siteConfig.tagline} {{.Description}} {{ printf "%+v" (.Option $option)}} {{if (index .Options "deprecated"|default false)}}Deprecated. {{end}}{{.Description}} {{if .DefaultValue}}Default: {{.DefaultValue}}{{end}} {{ printf "%+v" (.Option $option)}} {{.Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} {{.Description}} {{.Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}}\n ').concat(i||c?u:"","\n ")}))})},window.$docsify.plugins)}();
+//# sourceMappingURL=docsify-plugin-flexible-alerts.min.js.map
\ No newline at end of file
diff --git a/docs/js/docsify-sidebar-collapse.min.js b/docs/js/docsify-sidebar-collapse.min.js
new file mode 100644
index 0000000000..2b067c7e25
--- /dev/null
+++ b/docs/js/docsify-sidebar-collapse.min.js
@@ -0,0 +1 @@
+!function(e){("object"!=typeof exports||"undefined"==typeof module)&&"function"==typeof define&&define.amd?define(e):e()}(function(){"use strict";function e(e,n){var t,a=(n=void 0===n?{}:n).insertAt;e&&"undefined"!=typeof document&&(t=document.head||document.getElementsByTagName("head")[0],(n=document.createElement("style")).type="text/css","top"===a&&t.firstChild?t.insertBefore(n,t.firstChild):t.appendChild(n),n.styleSheet?n.styleSheet.cssText=e:n.appendChild(document.createTextNode(e)))}var t;function a(e){e&&null!=t&&(e=e.getBoundingClientRect().top,document.querySelector(".sidebar").scrollBy(0,e-t))}function n(){requestAnimationFrame(function(){var e=document.querySelector(".app-sub-sidebar > .active");if(e)for(e.parentNode.parentNode.querySelectorAll(".app-sub-sidebar").forEach(function(e){return e.classList.remove("open")});e.parentNode.classList.contains("app-sub-sidebar")&&!e.parentNode.classList.contains("open");)e.parentNode.classList.add("open"),e=e.parentNode})}function o(e){t=e.target.getBoundingClientRect().top;var n=d(e.target,"LI",2);n&&(n.classList.contains("open")?(n.classList.remove("open"),setTimeout(function(){n.classList.add("collapse")},0)):(function(e){if(e)for(e.classList.remove("open","active");e&&"sidebar-nav"!==e.className&&e.parentNode;)"LI"!==e.parentNode.tagName&&"app-sub-sidebar"!==e.parentNode.className||e.parentNode.classList.remove("open"),e=e.parentNode}(s()),i(n),setTimeout(function(){n.classList.remove("collapse")},0)),a(n))}function s(){var e=document.querySelector(".sidebar-nav .active");return e||(e=d(document.querySelector('.sidebar-nav a[href="'.concat(decodeURIComponent(location.hash).replace(/ /gi,"%20"),'"]')),"LI",2))&&e.classList.add("active"),e}function i(e){if(e)for(e.classList.add("open","active");e&&"sidebar-nav"!==e.className&&e.parentNode;)"LI"!==e.parentNode.tagName&&"app-sub-sidebar"!==e.parentNode.className||e.parentNode.classList.add("open"),e=e.parentNode}function d(e,n,t){if(e&&e.tagName===n)return e;for(var a=0;e;){if(t<++a)return;if(e.parentNode.tagName===n)return e.parentNode;e=e.parentNode}}e(".sidebar-nav > ul > li ul {\n display: none;\n}\n\n.app-sub-sidebar {\n display: none;\n}\n\n.app-sub-sidebar.open {\n display: block;\n}\n\n.sidebar-nav .open > ul:not(.app-sub-sidebar),\n.sidebar-nav .active:not(.collapse) > ul {\n display: block;\n}\n\n/* 抖动 */\n.sidebar-nav li.open:not(.collapse) > ul {\n display: block;\n}\n\n.active + ul.app-sub-sidebar {\n display: block;\n}\n"),document.addEventListener("scroll",n);e("@media screen and (max-width: 768px) {\n /* 移动端适配 */\n .markdown-section {\n max-width: none;\n padding: 16px;\n }\n /* 改变原来按钮热区大小 */\n .sidebar-toggle {\n padding: 0 0 10px 10px;\n }\n /* my pin */\n .sidebar-pin {\n appearance: none;\n outline: none;\n position: fixed;\n bottom: 0;\n border: none;\n width: 40px;\n height: 40px;\n background: transparent;\n }\n}\n");var r,c="DOCSIFY_SIDEBAR_PIN_FLAG";function l(){var e="true"===(e=localStorage.getItem(c));localStorage.setItem(c,!e),e?(document.querySelector(".sidebar").style.transform="translateX(0)",document.querySelector(".content").style.transform="translateX(0)"):(document.querySelector(".sidebar").style.transform="translateX(300px)",document.querySelector(".content").style.transform="translateX(300px)")}768 --\x3e'),u="\n".concat(m,"\x3c!-- ").concat(t," --\x3e");for(var v=function(){f.innerHTML=n[2].trim()?r.compiler.compile(n[2]).replace(/<\/?p>/g,""):"Tab ".concat(l);var a=f.innerHTML,e=(n[3]||"").trim(),c=(f.textContent||f.firstChild.getAttribute("alt")||f.firstChild.getAttribute("src")).trim().toLowerCase();i=i.replace(n[0],(function(){return["\n".concat(m,"\x3c!-- ").concat(t,' --\x3e"),"\n".concat(m,"\x3c!-- ").concat(t,' --\x3e'),"\n\n".concat(m).concat(e),"\n\n".concat(m,"\x3c!-- ").concat(t," --\x3e")].join("")})),l++};null!==(n=(e.tabComments?a.tabCommentMarkup.exec(i):null)||(e.tabHeadings?a.tabHeadingMarkup.exec(i):null));)v()}i=(i=i.replace(h,(function(){return d}))).replace(g,(function(){return u})),c=c.replace(s[0],(function(){return i}))};null!==(s=a.tabBlockMarkup.exec(c));)u();return d.forEach((function(t,o){c=c.replace(t,(function(){return i[o]}))})),c}(c,r)),c})),c.afterEach((function(t,o){i&&(t=function(t){for(var o,e=function(){var a=o[0],e=o[1]||"";t=t.replace(a,(function(){return e}))};null!==(o=a.commentReplaceMarkup.exec(t));)e();return t}(t)),o(t)})),c.doneEach((function(){var t,a,c,r;i&&(a=(t=document.querySelector(".".concat(o.tabsContainer)))?Array.apply(null,t.querySelectorAll(".".concat(o.tabBlock))):[],c=JSON.parse(sessionStorage.getItem(window.location.href))||{},r=JSON.parse(sessionStorage.getItem("*"))||[],n(),a.forEach((function(t,a){var s=t.querySelector(".".concat(o.tabButtonActive));s||(e.sync&&r.length&&(s=r.map((function(a){return t.querySelector(".".concat(o.tabButton,'[data-tab="').concat(a,'"]'))})).filter((function(t){return t}))[0]),!s&&e.persist&&(s=t.querySelector(".".concat(o.tabButton,'[data-tab="').concat(c[a],'"]'))),(s=s||t.querySelector(".".concat(o.tabButton)))&&s.classList.add(o.tabButtonActive))})))})),c.mounted((function(){var t=document.querySelector(".".concat(o.tabsContainer));t&&t.addEventListener("click",(function(t){s(t.target)})),window.addEventListener("hashchange",n,!1)}))}),window.$docsify.plugins||[])))}();
+//# sourceMappingURL=docsify-tabs.min.js.map
diff --git a/docs/js/index.js b/docs/js/index.js
new file mode 100644
index 0000000000..4a6ec1bc59
--- /dev/null
+++ b/docs/js/index.js
@@ -0,0 +1,61 @@
+;(function(win) {
+ function isFunction(functionToCheck) {
+ return functionToCheck && {}.toString.call(functionToCheck) === '[object Function]'
+ }
+
+ win.EditOnGithubPlugin = {}
+
+ function create(docBase, docEditBase, title) {
+ title = title || 'Edit on github'
+ docEditBase = docEditBase || docBase.replace(/\/blob\//, '/edit/')
+
+ function editDoc(event, vm) {
+ var docName = vm.route.file
+
+ if (docName) {
+ var editLink = docEditBase + docName
+ window.open(editLink)
+ event.preventDefault()
+ return false
+ } else {
+ return true
+ }
+ }
+
+ win.EditOnGithubPlugin.editDoc = editDoc
+
+ function generateHeader(title) {
+ return header = [
+ '',
+ '',
+ ''
+ ].join('')
+ }
+
+ return function(hook, vm) {
+ win.EditOnGithubPlugin.onClick = function(event) {
+ EditOnGithubPlugin.editDoc(event, vm)
+ }
+
+ if (isFunction(title)) {
+
+ hook.afterEach(function (html) {
+ return generateHeader(title(vm.route.file)) + html
+ })
+ } else {
+ var header = generateHeader(title)
+
+ hook.afterEach(function (html) {
+ return header + html
+ })
+ }
+
+
+ }
+ }
+
+ win.EditOnGithubPlugin.create = create
+}) (window)
diff --git a/docs/js/pangu.min.js b/docs/js/pangu.min.js
new file mode 100644
index 0000000000..35aa599fa2
--- /dev/null
+++ b/docs/js/pangu.min.js
@@ -0,0 +1 @@
+$docsify.plugins=[].concat(function(n){n.init(function(n){var c;(c=document.createElement("script")).async=!0,c.src="https://cdn.jsdelivr.net/npm/pangu",document.body.appendChild(c)}),n.doneEach(function(n){try{pangu.spacingElementByClassName("content")}catch(n){}})},$docsify.plugins);
diff --git a/docs/js/progress.js b/docs/js/progress.js
new file mode 100644
index 0000000000..087951e8a8
--- /dev/null
+++ b/docs/js/progress.js
@@ -0,0 +1,70 @@
+function plugin(hook, vm) {
+ let marginTop
+ hook.mounted(function () {
+ const content = document.getElementsByClassName("content")[0]
+ marginTop = parseFloat(
+ window.getComputedStyle(content).paddingTop.replace("px", "")
+ )
+
+ let insertDOM = `
+
+
+
+ `
+ const mainDOM = document.getElementsByTagName("body")[0]
+ mainDOM.innerHTML = mainDOM.innerHTML + insertDOM
+
+ function switcher() {
+ const body = document.getElementsByTagName("body")[0]
+ if (!body.classList.contains("close")) {
+ body.classList.add("close")
+ } else {
+ body.classList.remove("close")
+ }
+ }
+
+ const btn = document.querySelector("div.sidebar-toggle-button")
+ btn.addEventListener("click", function (e) {
+ e.stopPropagation()
+ switcher()
+ })
+ })
+ hook.ready(function () {
+ window.addEventListener("scroll", function (e) {
+ let totalHeight =
+ marginTop +
+ parseFloat(
+ window
+ .getComputedStyle(document.getElementById("main"))
+ .height.replace("px", "")
+ )
+ let scrollTop =
+ document.body.scrollTop + document.documentElement.scrollTop
+ let remain = totalHeight - document.body.offsetHeight
+ document.getElementById("progress-display").style.width =
+ Math.ceil((scrollTop / remain) * 100) + "%"
+ })
+ })
+}
+
+// Docsify plugin options
+window.$docsify["progress"] = Object.assign(
+ {
+ position: "top",
+ color: "var(--theme-color,#42b983)",
+ height: "3px",
+ },
+ window.$docsify["progress"]
+)
+window.$docsify.plugins = [].concat(plugin, window.$docsify.plugins)
diff --git a/docs/js/time-updater.min.js b/docs/js/time-updater.min.js
new file mode 100644
index 0000000000..5e891b480e
--- /dev/null
+++ b/docs/js/time-updater.min.js
@@ -0,0 +1 @@
+let defaultDocsifyUpdatedOptions={text:">Last Modify: {docsify-updated}",formatUpdated:"{YYYY}/{MM}/{DD}",whereToPlace:"bottom"};function plugin(t,d){let o=d.config.timeUpdater.text,i=String(d.config.timeUpdater.whereToPlace).toLowerCase();t.beforeEach(function(t){return"top"!==i?t+"\n\n"+o:o+"\n\n"+t})}window.$docsify=window.$docsify||{},window.$docsify.formatUpdated=(window.$docsify.timeUpdater||defaultDocsifyUpdatedOptions).formatUpdated,window.$docsify.timeUpdater=Object.assign(defaultDocsifyUpdatedOptions,window.$docsify.timeUpdater),window.$docsify.plugins=(window.$docsify.plugins||[]).concat(plugin);
\ No newline at end of file
diff --git a/docs/sdk/go-sdk b/docs/sdk/go-sdk
new file mode 100644
index 0000000000..4be35e39d6
--- /dev/null
+++ b/docs/sdk/go-sdk
@@ -0,0 +1,6 @@
+
+
+
+
+
+
diff --git a/docs/sidebars.js b/docs/sidebars.js
deleted file mode 100644
index 84ab33a393..0000000000
--- a/docs/sidebars.js
+++ /dev/null
@@ -1,553 +0,0 @@
-
-
-const sidebars = {
-
- mySidebar: [
- {
- type: 'doc',
- label: '首页',
- id: 'README'
- },
- {
- type: 'category',
- label: '快速开始',
- link: {
- type: 'doc',
- id: 'start/README',
- },
- items: [
- {
- type: "doc",
-
- id: "start/state/start",
- },
- {
- type: "category",
- label: "使用Configuration API",
- items:[
- "start/configuration/start-apollo",
- {
- type: "doc",
- id: "start/configuration/start",
- },
- {
- type: "doc",
- id: "start/configuration/start-nacos",
- },
- ]
- },
- {
- type: "doc",
- id: "start/pubsub/start",
- },
- {
- type: "doc",
- id: "start/delay_queue/start",
- },
- {
- type: "doc",
- id: "start/lock/start",
- },
- {
- type: "doc",
- id: "start/sequencer/start",
- },
- {
- type: "doc",
- id: "start/secret/start",
- },
- {
- type: "doc",
- id: "start/rpc/helloworld",
- },
- {
- type: "doc",
- id: "start/file/minio",
- },
- {
- type: "doc",
- id: "start/oss/oss",
- },
- {
- type: "doc",
- id: "start/uds/start",
- },
- {
- type: "doc",
- id: "start/sms/start",
- },
- {
- type: "doc",
- id: "start/cryption/start",
- },
- {
- type: "doc",
- id: "start/phone/start",
- },
- {
- type: "doc",
- id: "start/email/start",
- },
- { type: "doc", id: "start/lifecycle/start", },
- {
- type: 'category',
- label: 'API插件',
- items: [
- {
- type: 'doc',
- id: 'start/api_plugin/helloworld',
- },
- {
- type: 'doc',
- id: 'start/api_plugin/generate',
- }
- ]},
- {
- type: 'category',
- label: '作为 Istio 的数据面',
- items: [
- {
- type: 'doc',
- id: 'start/istio/README',
- },
- {
- type: 'doc',
- id: 'start/istio/start',
- },
- ],
- },
- {
- type: 'category',
- label: '在四层网络进行流量干预',
- items: [
- {
- type: 'doc',
- id: 'start/network_filter/tcpcopy',
- },
- ],
- },
- {
- type: 'category',
- label: '在七层网络进行流量干预',
- items: [
- {
- type: 'doc',
- id: 'start/stream_filter/flow_control',
- },
- ],
- },
- {
- type: 'doc',
- id: 'start/actuator/start',
- },
- {
- type: 'category',
- label: '可观测性',
- items: [
- {
- type: 'doc',
- id: 'start/trace/trace',
- },
- {
- type: 'doc',
- id: 'start/trace/skywalking',
- },
- {
- type: 'doc',
- id: 'start/trace/zipkin',
- },
- {
- type: 'doc',
- id: 'start/trace/jaeger',
- },
- {
- type: 'doc',
- id: 'start/trace/prometheus',
- },
- ],
- },
- {
- type: 'doc',
- id: 'start/wasm/start',
- },
- {
- type: 'doc',
- id: 'start/faas/start',
- }]
- },
- {
- type: 'doc',
- label: '线上实验室',
- id: 'start/lab'
- },
- {
- type: 'category',
- label: '用户手册',
- items: [
- {
- type: 'category',
- label: '功能介绍',
- items: [
- {
- type: 'doc',
- id: 'building_blocks/file/file',
- },
- {
- type: 'doc',
- id: 'building_blocks/actuator/actuator',
- },
- {
- type: 'doc',
- id: 'building_blocks/state/reference',
- },
- {
- type: 'doc',
- id: 'building_blocks/sequencer/reference',
- },
- {
- type: 'doc',
- id: 'building_blocks/lock/reference',
- },
- {
- type: 'doc',
- id: 'building_blocks/pubsub/reference',
- },
- {
- type: 'doc',
- id: 'building_blocks/rpc/reference',
- },
- {
- type: 'doc',
- id: 'building_blocks/configuration/reference',
- },
- {
- type: 'category',
- label: '可扩展性',
- items: [
- {
- type: 'doc',
- id: 'design/api_plugin/design',
- },
- {
- type: 'doc',
- id: 'design/pluggable/usage',
- },
- ],
- },
- ],
- },
- {
- "type": "doc",
- "id": "api_reference/README"
- },
- {
- "type": "link",
- label: 'java sdk',
- "href": "https://github.com/layotto/java-sdk"
- },
- {
- "type": "link",
- label: '.net sdk',
-
- "href": "https://github.com/layotto/dotnet-sdk"
- },
- {
- "type": "link",
- label: 'js sdk',
- "href": "https://github.com/layotto/js-sdk"
- },
- {
- "type": "doc",
- "id": "sdk_reference/go/start"
- }
-
- ],
- },
-
- //
-
-{
- type: 'category',
- label: '运维手册',
- items: [
- {
- type: 'category',
- label: '如何配置 Layotto',
- items: [
- {
- type: 'doc',
- id: 'configuration/overview',
- },
- {
- type: 'category',
- label: '组件配置说明',
- link:{
- type:"doc",
- id:"component_specs/overview"
- },
- items: [
- {
- type: 'category',
- label: 'State',
- link:{
- type:"doc",
- id:"component_specs/state/common"
- },
- items: [
- {
- type: 'doc',
- id: 'component_specs/state/redis',
- },
- {
- type: 'doc',
- id: 'component_specs/state/others',
- },
- ],
- },
- {
- type: 'category',
- label: 'Pub/Sub',
- link:{
- type:"doc",
- id:"component_specs/pubsub/common"
- },
- items: [
- {
- type: 'doc',
- id: 'component_specs/pubsub/redis',
- },
- {
- type: 'doc',
- id: 'component_specs/pubsub/others',
- },
- ],
- },
- {
- type: 'category',
- label: 'Distributed Lock',
- link:{
- type:"doc",
- id:"component_specs/lock/common"
- },
- items: [
- {
- type: 'doc',
- id: 'component_specs/lock/redis',
- },
- {
- type: 'doc',
- id: 'component_specs/lock/etcd',
- },
- {
- type: 'doc',
- id: 'component_specs/lock/zookeeper',
- },
- {
- type: 'doc',
- id: 'component_specs/lock/consul',
- },
- {
- type: 'doc',
- id: 'component_specs/lock/mongo',
- },
- ],
- },
- {
- type: 'doc',
- id: 'component_specs/configuration/etcd',
- },
- {
- type: 'doc',
- id: 'component_specs/file/oss',
- },
- {
- type: 'category',
- label: 'Sequencer',
- items: [{
- "type": "doc",
- "id": "component_specs/sequencer/etcd"
- },
- {
- "type": "doc",
- "id": "component_specs/sequencer/redis"
- },
- {
- "type": "doc",
- "id": "component_specs/sequencer/zookeeper"
- },
- {
- "type": "doc",
- "id": "component_specs/sequencer/mongo"
- },
- {
- "type": "doc",
- "id": "component_specs/sequencer/mysql"
- },
- {
- "type": "doc",
- "id": "component_specs/sequencer/snowflake"
- }
-
- ],
- },
- {
- type: 'doc',
- id: 'component_specs/secret/common',
- },
- {
- type: 'doc',
- id: 'component_specs/custom/common',
- },
- ],
- },
- ],
- },
- {
- type: 'doc',
- id: 'operation/README',
- },
- {
- type: 'doc',
- id: 'operation/sidecar_injector',
- },
- {
- type: 'doc',
- id: 'operation/local',
- },
- ]
-},
-
-
- //
- {
- type: 'category',
- label: '设计文档',
- items: [
- {
- type: 'doc',
- id: 'design/lifecycle/apply_configuration',
- },
- {
- type: 'doc',
- id: 'design/actuator/actuator-design-doc',
- },
- {
- type: 'doc',
- id: 'design/actuator/grpc-design-doc',
- },
- {
- type: 'doc',
- id: 'design/configuration/configuration-api-with-apollo',
- },
- {
- type: 'doc',
- id: 'design/pubsub/pubsub-api-and-compability-with-dapr-component',
- },
- {
- type: 'doc',
- id: 'design/rpc/rpc_design_document',
- },
- {
- type: 'doc',
- id: 'design/lock/lock-api-design',
- },
- {
- type: 'doc',
- id: 'design/sequencer/design',
- },
- {
- type: 'doc',
- id: 'design/file/file-design',
- },
- {
- type: 'doc',
- id: 'design/faas/faas-poc-design',
- },
- {
- type: 'doc',
- id: 'design/api_plugin/design',
- },
- {
- type: 'doc',
- id: 'design/api_plugin/dapr_api',
- },
- {
- type: 'doc',
- id: 'design/oss/design',
- },
- {
- type: 'doc',
- id: 'design/pluggable/design',
- },
- ],
- },
- {
- type: "category",
- label: "贡献指南",
- items: [
- "development/CONTRIBUTING",
- "development/start-from-zero",
- {
- type: "category",
- label: "想要贡献文档?",
- items: ["development/contributing-doc", "development/test-quickstart"]
- },
- "development/developing-component",
- "development/component_ref/component_ref",
- {
- type: "category",
- label: "想要修改proto文件或API定义？",
- items: [
- "api_reference/how_to_generate_api_doc",
- "api_reference/comment_spec_of_proto",
- "development/developing-api"
- ]
- },
- {
- type: "doc",
- id: "development/github-workflows"
- },
- {
- type: "doc",
- id: "development/commands"
- },
- {
- type: "category",
- label: "如何给 issue 打 label",
- items: [
- {
- type: "doc",
- id: "development/label-spec"
- }
- ]
- },
- {
- type: "doc",
- id: "development/release-guide"
- },
- {
- type: "doc",
- id: "development/problems-to-solve"
- }
- ]
- }
-,
- {
- type: "category",
- label: "社区",
- items: [
- "community/meeting",
- "community/governance",
- "community/promote",
- "community/people"
- ]
- },
-
- {
- type: "doc",
- id: "video/README"
- }
- ]
-};
-
-export default sidebars;
diff --git a/docs/spec b/docs/spec
new file mode 100644
index 0000000000..4be35e39d6
--- /dev/null
+++ b/docs/spec
@@ -0,0 +1,6 @@
+
+
+
+
+
+
diff --git a/docs/src/components/HomepageFeatures/index.js b/docs/src/components/HomepageFeatures/index.js
deleted file mode 100644
index 784b0a9d64..0000000000
--- a/docs/src/components/HomepageFeatures/index.js
+++ /dev/null
@@ -1,61 +0,0 @@
-import clsx from 'clsx';
-import Heading from '@theme/Heading';
-import styles from './styles.module.css';
-
-const FeatureList = [
- {
- title: '易用性',
- Svg: require('@site/static/img/undraw_docusaurus_mountain.svg').default,
- description: (
- <>
- 非常容易使用
-
- ),
- },
- {
- title: '专注方面',
- Svg: require('@site/static/img/undraw_docusaurus_tree.svg').default,
- description: (
- <>
- 网络
-
- ),
- },
- {
- title: '适合人群',
- Svg: require('@site/static/img/undraw_docusaurus_react.svg').default,
- description: (
- <>
- 适合人群：程序员等
-
- ),
- },
-];
-
-function Feature({Svg, title, description}) {
- return (
-
-
- );
-}
-
-export default function HomepageFeatures() {
- return (
-
-
-
-
-
-
-
-
- {FeatureList.map((props, idx) => (
-
-
-//
-//
-//
-// Layotto Tutorial - 5min ⏱️
-//
-//
-// Protocol Documentation
+
+ Table of Contents
+
+
+
+
+ {{range .Files}}
+ {{$file_name := .Name}}
+
+ {{range .Files}}
+ {{$file_name := .Name}}
+
+
+
+ {{range .Services}}
+
+
+
+ {{p .Description}}
+
+ {{range .Services}}
+ {{.Name}}
Top
+ [gRPC Service] {{.Name}}
+ {{p .Description}}
+
+
+
+
+ {{$service := .}}
+ {{- range .MethodOptions}}
+ {{$option := .}}
+ {{if eq . "google.api.http"}}
+ Method Name Request Type Response Type Description
+
+ {{end}}
+
+ {{.Name}}
+ {{.RequestLongType}}{{if .RequestStreaming}} stream{{end}}
+ {{.ResponseLongType}}{{if .ResponseStreaming}} stream{{end}}
+ Methods with HTTP bindings
+
+
+
+ {{else}}
+
+
+
+
+ {{range $service.MethodsWithOption .}}
+ {{$name := .Name}}
+ {{range (.Option $option).Rules}}
+ Method Name
+ Method
+ Pattern
+ Body
+
+
+ {{end}}
+ {{end}}
+
+ {{$name}}
+ {{.Method}}
+ {{.Pattern}}
+ {{.Body}}
+ Methods with {{.}} option
+
+
+
+ {{end}}
+ {{end -}}
+ {{end}}
+
+ {{range .Messages}}
+
+
+
+
+ {{range $service.MethodsWithOption .}}
+ Method Name
+ Option
+
+
+ {{end}}
+
+ {{.Name}}
+ {{.LongName}}
+ {{p .Description}}
+
+ {{if .HasFields}}
+
+
+
+
+ {{$message := .}}
+ {{- range .FieldOptions}}
+ {{$option := .}}
+ {{if eq . "validator.field" "validate.rules" }}
+ Field Type Label Description
+
+ {{end}}
+
+ {{.Name}}
+ {{.LongType}}
+ {{.Label}}
+ Validated Fields
+
+
+
+ {{else}}
+
+
+
+
+ {{range $message.FieldsWithOption .}}
+ Field
+ Validations
+
+
+ {{end}}
+
+ {{.Name}}
+
+
+
+ {{range (.Option $option).Rules}}
+
+ Fields with {{.}} option
+
+
+
+ {{end}}
+ {{end -}}
+ {{end}}
+
+ {{if .HasExtensions}}
+
+
+
+
+ {{range $message.FieldsWithOption .}}
+ Name
+ Option
+
+
+ {{end}}
+
+ {{.Name}}
+
+
+
+
+ {{end}}
+ {{end}}
+
+ {{range .Enums}}
+ Extension Type Base Number Description
+
+ {{end}}
+
+ {{.Name}}
+ {{.LongType}}
+ {{.ContainingLongType}}
+ {{.Number}}
+ {{.LongName}}
+ {{p .Description}}
+
+
+
+ {{end}}
+
+ {{if .HasExtensions}}
+ Name Number Description
+
+ {{end}}
+
+ {{.Name}}
+ {{.Number}}
+ File-level Extensions
+
+
+
+ {{end}}
+
+ {{end}}
+
+
+
diff --git a/docs/template/api_ref_md.tmpl b/docs/template/api_ref_md.tmpl
new file mode 100644
index 0000000000..64fff10254
--- /dev/null
+++ b/docs/template/api_ref_md.tmpl
@@ -0,0 +1,75 @@
+{{range .Files}}
+{{$file_name := .Name}}
+
+
+# {{.Name}}
+
+
+This document is automaticallly generated from the [`.proto`](https://github.com/mosn/layotto/tree/main/spec/proto/runtime/v1) files.
+
+{{.Description}}
+
+{{range .Services}}
+
+
+## [gRPC Service] {{.Name}}
+{{.Description}}
+
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+{{range .Methods -}}
+ | {{.Name}} | [{{.RequestLongType}}](#{{.RequestFullType}}){{if .RequestStreaming}} stream{{end}} | [{{.ResponseLongType}}](#{{.ResponseFullType}}){{if .ResponseStreaming}} stream{{end}} | {{nobr .Description}} |
+{{end}}
+{{end}}
+
+{{range .Messages}}
+
+
+
+## {{.LongName}}
+{{.Description}}
+
+{{if .HasFields}}
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+{{range .Fields -}}
+ | {{.Name}} | [{{.LongType}}](#{{.FullType}}) | {{.Label}} | {{if (index .Options "deprecated"|default false)}}**Deprecated.** {{end}}{{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} |
+{{end}}
+{{end}}
+
+{{if .HasExtensions}}
+| Extension | Type | Base | Number | Description |
+| --------- | ---- | ---- | ------ | ----------- |
+{{range .Extensions -}}
+ | {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} |
+{{end}}
+{{end}}
+
+{{end}}
+
+{{range .Enums}}
+
+
+## {{.LongName}}
+{{.Description}}
+
+| Name | Number | Description |
+| ---- | ------ | ----------- |
+{{range .Values -}}
+ | {{.Name}} | {{.Number}} | {{nobr .Description}} |
+{{end}}
+
+{{end}}
+
+{{if .HasExtensions}}
+
+
+## File-level Extensions
+| Extension | Type | Base | Number | Description |
+| --------- | ---- | ---- | ------ | ----------- |
+{{range .Extensions -}}
+ | {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: `{{.DefaultValue}}`{{end}} |
+{{end}}
+{{end}}
+
+{{end}}
\ No newline at end of file
diff --git a/docs/template/quickstart.tmpl b/docs/template/quickstart.tmpl
new file mode 100644
index 0000000000..3f05417993
--- /dev/null
+++ b/docs/template/quickstart.tmpl
@@ -0,0 +1,125 @@
+{{range .Files}} {{$file_name := .Name}} {{if .HasServices}} {{range .Services}}
+# {{.Name}} API demo
+
+This example shows how to invoke Layotto {{.Name}} API.
+
+## What is {{.Name}} API used for?
+
+{{.Description}}
+
+## step 1. Deploy Layotto
+
+### **With Docker**
+You can start Layotto with docker
+
+```bash
+docker run -v "$(pwd)/configs/config_standalone.json:/runtime/configs/config.json" -d -p 34904:34904 --name layotto layotto/layotto start
+```
+
+### **Compile locally (not for Windows)**
+You can compile and run Layotto locally.
+
+> [!TIP|label: Not for Windows users]
+> Layotto fails to compile under Windows. Windows users are recommended to deploy using docker
+
+After downloading the project code to the local, switch the code directory and compile:
+
+```shell
+cd ${project_path}/cmd/layotto
+```
+
+```shell @if.not.exist layotto
+go build
+```
+
+Once finished, the layotto binary will be generated in the directory.
+
+Run it:
+
+```shell @background
+./layotto start -c ../../configs/config_standalone.json
+```
+
+
+
+## step 2. Run the client program to invoke Layotto {{.Name}} API
+
+### **Go**
+Build and run the golang demo:
+
+```shell
+ cd ${project_path}/demo/{{$file_name}}/common/
+ go build -o client
+ ./client -s "demo"
+```
+
+If the following information is printed, the demo is successful:
+
+```bash
+TODO
+```
+
+### **Java**
+
+Download java sdk and examples:
+
+```shell @if.not.exist java-sdk
+git clone https://github.com/layotto/java-sdk
+```
+
+```shell
+cd java-sdk
+```
+
+Build the demo:
+
+```shell @if.not.exist examples-{{$file_name}}/target/examples-{{$file_name}}-jar-with-dependencies.jar
+# build example jar
+mvn -f examples-{{$file_name}}/pom.xml clean package
+```
+
+Run it:
+
+```shell
+java -jar examples-{{$file_name}}/target/examples-{{$file_name}}-jar-with-dependencies.jar
+```
+
+If the following information is printed, the demo is successful:
+
+```bash
+TODO
+```
+
+
+
+## step 3. Stop containers and release resources
+
+### **Destroy the Docker container**
+If you started Layotto with docker, you can destroy the container as follows:
+
+```bash
+docker rm -f layotto
+```
+
+
+
+## Next step
+### What does this client program do?
+The demo client program uses the SDK provided by Layotto to invoke the Layotto {{.Name}} API.
+
+The golang sdk is located in the `sdk` directory, and the java sdk is in https://github.com/layotto/java-sdk
+
+In addition to using sdk, you can also interact with Layotto directly through grpc in any language you like.
+
+### Details later, let's continue to experience other APIs
+Explore other Quickstarts through the navigation bar on the left.
+
+### Reference
+
+
+
+
+
+{{end}}
+{{end}}
+{{end}}
\ No newline at end of file
diff --git a/docs/template/quickstart_zh.tmpl b/docs/template/quickstart_zh.tmpl
new file mode 100644
index 0000000000..c98b064bf7
--- /dev/null
+++ b/docs/template/quickstart_zh.tmpl
@@ -0,0 +1,125 @@
+{{range .Files}} {{$file_name := .Name}} {{if .HasServices}} {{range .Services}}
+# {{.Name}} API demo
+
+本示例演示如何调用 Layotto {{.Name}} API.
+
+## 什么是 {{.Name}} API ?
+
+{{.Description}}
+
+## step 1. 运行 Layotto
+
+### **With Docker**
+您可以用 Docker 启动 Layotto
+
+```bash
+docker run -v "$(pwd)/configs/config_standalone.json:/runtime/configs/config.json" -d -p 34904:34904 --name layotto layotto/layotto start
+```
+
+### **本地编译（不适合 Windows)**
+您可以本地编译、运行 Layotto。
+> [!TIP|label: 不适合 Windows 用户]
+> Layotto 在 Windows 下会编译失败。建议 Windows 用户使用 docker 部署
+
+将项目代码下载到本地后，切换代码目录：
+
+```shell
+cd ${project_path}/cmd/layotto
+```
+
+构建:
+
+```shell @if.not.exist layotto
+go build
+```
+
+完成后目录下会生成 Layotto文件，运行它：
+
+```shell @background
+./layotto start -c ../../configs/config_standalone.json
+```
+
+
+
+## step 2. 运行客户端程序，调用 Layotto {{.Name}} API
+
+### **Go**
+
+构建、运行 go 语言 demo:
+
+```shell
+ cd ${project_path}/demo/{{$file_name}}/common/
+ go build -o client
+ ./client -s "demo"
+```
+
+打印出如下信息则代表调用成功：
+
+```bash
+TODO
+```
+
+### **Java**
+
+下载 java sdk 和示例代码:
+
+```shell @if.not.exist java-sdk
+git clone https://github.com/layotto/java-sdk
+```
+
+```shell
+cd java-sdk
+```
+
+构建 examples:
+
+```shell @if.not.exist examples-{{$file_name}}/target/examples-{{$file_name}}-jar-with-dependencies.jar
+# build example jar
+mvn -f examples-{{$file_name}}/pom.xml clean package
+```
+
+运行:
+
+```shell
+java -jar examples-{{$file_name}}/target/examples-{{$file_name}}-jar-with-dependencies.jar
+```
+
+打印出以下信息说明运行成功:
+
+```bash
+TODO
+```
+
+
+
+## step 3. 销毁容器,释放资源
+
+### **销毁 Docker container**
+如果您是用 Docker 启动的 Layotto，可以按以下方式销毁容器：
+
+```bash
+docker rm -f layotto
+```
+
+
+
+## 下一步
+### 这个客户端程序做了什么？
+示例客户端程序中使用了 Layotto 提供的多语言 sdk，调用Layotto {{.Name}} API。
+
+go sdk位于`sdk`目录下，java sdk 在 https://github.com/layotto/java-sdk
+
+除了使用sdk调用Layotto提供的API，您也可以用任何您喜欢的语言、通过grpc直接和Layotto交互。
+
+### 细节以后再说，继续体验其他API
+通过左侧的导航栏，继续体验别的API吧！
+
+### Reference
+
+
+
+
+
+{{end}}
+{{end}}
+{{end}}
\ No newline at end of file
diff --git a/docs/src/pages/index.md b/docs/zh/README.md
similarity index 85%
rename from docs/src/pages/index.md
rename to docs/zh/README.md
index defd6ba739..50c1aaec9b 100644
--- a/docs/src/pages/index.md
+++ b/docs/zh/README.md
@@ -1,7 +1,8 @@
-# Layotto (L8): To be the next layer of OSI layer 7
-Extension Type Base Number Description
+
+ {{end}}
+
+ {{.Name}}
+ {{.LongType}}
+ {{.ContainingLongType}}
+ {{.Number}}
+ Layotto (L8): To be the next layer of OSI layer 7
+
-[](https://github.com/mosn/layotto/actions/workflows/proto-checker.yml)
+[](https://github.com/mosn/layotto/actions/workflows/quickstart-checker.yml)
[](https://github.com/mosn/layotto/actions/workflows/layotto-ci.yml)
[](https://godoc.org/mosn.io/layotto)
@@ -9,7 +10,7 @@
[](https://codecov.io/gh/mosn/layotto)
[](http://isitmaintained.com/project/mosn/layotto "Average time to resolve an issue")
-
+
|
+| 💬 [钉钉](https://www.dingtalk.com/zh) (社区会议群) | 群号：41585216
[Layotto 在每周五晚 8 点进行社区会议，欢迎所有人](zh/community/meeting.md) |
[comment]: <> (| 💬 [微信](https://www.wechat.com/) | 扫描下方二维码添加好友，她会邀请您加入微信群
)
## 如何贡献
-[新手攻略：从零开始成为 Layotto 贡献者](/docs/development/start-from-zero)
+[新手攻略：从零开始成为 Layotto 贡献者](zh/development/start-from-zero.md)
[从哪下手？看看"新手任务"列表](https://github.com/mosn/layotto/issues/108#issuecomment-872779356)
作为技术同学，你是否有过“想参与某个开源项目的开发、但是不知道从何下手”的感觉？
为了帮助大家更好的参与开源项目，社区会定期发布适合新手的新手开发任务，帮助大家 learning by doing!
-[文档贡献指南](/docs/development/contributing-doc)
+[文档贡献指南](zh/development/contributing-doc.md)
-[组件开发指南](/docs/development/developing-component)
+[组件开发指南](zh/development/developing-component.md)
-[Layotto Github Workflow 指南](/docs/development/github-workflows)
+[Layotto Github Workflow 指南](zh/development/github-workflows.md)
-[Layotto 命令行指南](/docs/development/commands)
+[Layotto 命令行指南](zh/development/commands.md)
-[Layotto 贡献者指南](/docs/development/CONTRIBUTING)
+[Layotto 贡献者指南](zh/development/CONTRIBUTING.md)
## 贡献者
@@ -164,17 +165,17 @@ Layotto enriches the CNCF CLOUD N
## 设计文档
-[Actuator 设计文档](/docs/design/actuator/actuator-design-doc)
+[Actuator 设计文档](zh/design/actuator/actuator-design-doc.md)
-[Pubsub API 与 Dapr Component 的兼容性](/docs/design/pubsub/pubsub-api-and-compability-with-dapr-component)
+[Pubsub API 与 Dapr Component 的兼容性](zh/design/pubsub/pubsub-api-and-compability-with-dapr-component.md)
-[Configuration API with Apollo](/docs/design/configuration/configuration-api-with-apollo)
+[Configuration API with Apollo](zh/design/configuration/configuration-api-with-apollo.md)
-[RPC 设计文档](/docs/design/rpc/rpc_design_document)
+[RPC 设计文档](zh/design/rpc/rpc设计文档.md)
-[分布式锁 API 设计文档](/docs/design/lock/lock-api-design)
+[分布式锁 API 设计文档](zh/design/lock/lock-api-design.md)
-[FaaS 设计文档](/docs/design/faas/faas-poc-design)
+[FaaS 设计文档](zh/design/faas/faas-poc-design.md)
## FAQ
diff --git a/docs/zh/_navbar.md b/docs/zh/_navbar.md
new file mode 100644
index 0000000000..4b8f5dfae5
--- /dev/null
+++ b/docs/zh/_navbar.md
@@ -0,0 +1 @@
+* [English](/en/README.md)
\ No newline at end of file
diff --git a/docs/zh/_sidebar.md b/docs/zh/_sidebar.md
new file mode 100644
index 0000000000..c4121a26ee
--- /dev/null
+++ b/docs/zh/_sidebar.md
@@ -0,0 +1,149 @@
+- [首页](/zh/README.md)
+- [快速开始](/zh/start/)
+ - [使用State API](zh/start/state/start.md)
+ - 使用Configuration API
+ - [使用Apollo配置中心](zh/start/configuration/start-apollo.md)
+ - [使用Etcd配置中心](zh/start/configuration/start.md)
+ - [使用Nacos配置中心](zh/start/configuration/start-nacos.md)
+ - 发布、订阅消息
+ - [使用Pub/Sub API](zh/start/pubsub/start.md)
+ - [(建设中) 使用 DelayQueue API](zh/start/delay_queue/start)
+ - [使用分布式锁 API](zh/start/lock/start.md)
+ - [使用Sequencer API生成分布式自增id](zh/start/sequencer/start.md)
+ - 使用 Secret API
+ - [查询 secrets](zh/start/secret/start.md)
+ - [在组件配置中引用 secret](zh/start/secret/secret_ref.md)
+ - 进行RPC调用
+ - [Hello World](zh/start/rpc/helloworld.md)
+ - [Dubbo JSON RPC](zh/start/rpc/dubbo_json_rpc.md)
+ - 使用File API
+ - [基于Minio](zh/start/file/minio.md)
+ - [使用 OSS API](zh/start/oss/oss.md)
+ - [使用UDS通信](zh/start/uds/start.md)
+
+ - [(建设中)使用 sms API](zh/start/sms/start)
+ - [(建设中)使用 cryption API](zh/start/cryption/start)
+ - [(建设中)使用 phone API](zh/start/phone/start)
+ - [(建设中)使用 email API](zh/start/email/start)
+ - [使用 lifecycle API](zh/start/lifecycle/start)
+ - API插件
+ - [注册您自己的API](zh/start/api_plugin/helloworld.md)
+ - [自动生成 API 插件](zh/start/api_plugin/generate.md)
+ - 作为 Istio 的数据面
+ - [集成 Istio 1.10.6 演示](zh/start/istio/)
+ - [集成 Istio 1.5.x 演示](zh/start/istio/start.md)
+ - 在四层网络进行流量干预
+ - [Dump TCP 流量](zh/start/network_filter/tcpcopy.md)
+ - 在七层网络进行流量干预
+ - [方法级别限流](zh/start/stream_filter/flow_control.md)
+ - [健康检查、查询运行时元数据](zh/start/actuator/start.md)
+ - 可观测性
+ - [Trace, Metrics](zh/start/trace/trace.md)
+ - [Trace 接入 Skywalking](zh/start/trace/skywalking.md)
+ - [Trace 接入 Zipkin](zh/start/trace/zipkin.md)
+ - [Trace 接入 Jaeger](zh/start/trace/jaeger.md)
+ - [Metrics 接入 Prometheus](zh/start/trace/prometheus.md)
+ - [将业务逻辑通过 WASM 下沉进sidecar](zh/start/wasm/start.md)
+ - [基于 WASM 跟 Runtime 实现的 Faas 模型](zh/start/faas/start.md)
+- [线上实验室](zh/start/lab.md)
+- [用户手册](zh/building_blocks/)
+ - 功能介绍
+ - [File API](zh/building_blocks/file/file.md)
+ - [Actuator API](zh/building_blocks/actuator/actuator.md)
+ - [State API](zh/building_blocks/state/reference.md)
+ - [Sequencer API](zh/building_blocks/sequencer/reference.md)
+ - [Distributed Lock API](zh/building_blocks/lock/reference.md)
+ - [Pub/Sub API](zh/building_blocks/pubsub/reference.md)
+ - [RPC API](zh/building_blocks/rpc/reference.md)
+ - [Configuration API](zh/building_blocks/configuration/reference.md)
+ - 可扩展性
+ - [API插件](zh/design/api_plugin/design.md)
+ - [pluggable component 组件](zh/design/pluggable/usage.md)
+ - [gRPC API 接口文档](zh/api_reference/README.md)
+ - SDK文档
+ - [java sdk](https://github.com/layotto/java-sdk)
+ - [.net sdk](https://github.com/layotto/dotnet-sdk)
+ - [js sdk](https://github.com/layotto/js-sdk)
+ - [go sdk](zh/sdk_reference/go/start.md)
+- 运维手册
+ - [如何配置 Layotto](zh/configuration/)
+ - [Layotto 配置文件介绍](zh/configuration/overview.md)
+ - [组件配置说明](zh/component_specs/overview.md)
+ - [State](zh/component_specs/state/common.md)
+ - [Redis](zh/component_specs/state/redis.md)
+ - [其他组件](zh/component_specs/state/others.md)
+ - [Pub/Sub](zh/component_specs/pubsub/common.md)
+ - [Redis](zh/component_specs/pubsub/redis.md)
+ - [其他组件](zh/component_specs/pubsub/others.md)
+ - [Distributed Lock](zh/component_specs/lock/common.md)
+ - [Redis](zh/component_specs/lock/redis.md)
+ - [Etcd](zh/component_specs/lock/etcd.md)
+ - [Zookeeper](zh/component_specs/lock/zookeeper.md)
+ - [Consul](zh/component_specs/lock/consul.md)
+ - [MongoDB](zh/component_specs/lock/mongo.md)
+ - Configuration
+ - [Etcd](zh/component_specs/configuration/etcd.md)
+ - [Apollo](zh/component_specs/configuration/apollo.md)
+ - [Nacos](zh/component_specs/configuration/nacos.md)
+ - [File](zh/component_specs/file/common.md)
+ - [OSS](zh/component_specs/file/oss.md)
+ - [Sequencer](zh/component_specs/sequencer/common.md)
+ - [Etcd](zh/component_specs/sequencer/etcd.md)
+ - [Redis](zh/component_specs/sequencer/redis.md)
+ - [Zookeeper](zh/component_specs/sequencer/zookeeper.md)
+ - [MongoDB](zh/component_specs/sequencer/mongo.md)
+ - [Mysql](zh/component_specs/sequencer/mysql.md)
+ - [Snowflake](zh/component_specs/sequencer/snowflake.md)
+ - [Secret Store](zh/component_specs/secret/common.md)
+ - [自定义组件](zh/component_specs/custom/common.md)
+ - [如何部署、升级 Layotto](zh/operation/)
+ - [Layotto sidecar injector](zh/operation/sidecar_injector.md)
+ - [如何本地开发、本地调试](zh/operation/local.md)
+- 设计文档
+ - [动态配置下发、组件热重载](zh/design/lifecycle/apply_configuration.md)
+ - [Actuator设计文档](zh/design/actuator/actuator-design-doc.md)
+ - [gRPC框架设计文档](zh/design/actuator/grpc-design-doc.md)
+ - [Configuration API with Apollo](zh/design/configuration/configuration-api-with-apollo.md)
+ - [Pub/Sub API以及与dapr component的兼容性](zh/design/pubsub/pubsub-api-and-compability-with-dapr-component.md)
+ - [RPC设计文档](zh/design/rpc/rpc设计文档.md)
+ - [分布式锁API设计文档](zh/design/lock/lock-api-design.md)
+ - [Sequencer API设计文档](zh/design/sequencer/design.md)
+ - [File API设计文档](zh/design/file/file-design.md)
+ - [FaaS 设计文档](zh/design/faas/faas-poc-design.md)
+ - [API插件](zh/design/api_plugin/design.md)
+ - [支持Dapr API](zh/design/api_plugin/dapr_api.md)
+ - [OSS API设计文档](zh/design/oss/design.md)
+ - [pluggable component 设计文档](zh/design/pluggable/design.md)
+- 贡献指南
+ - [Layotto 贡献指南](zh/development/CONTRIBUTING.md)
+ - [新手攻略：从零开始成为 Layotto 贡献者](zh/development/start-from-zero.md)
+ - 想要贡献文档?
+ - [文档贡献指南](zh/development/contributing-doc.md)
+ - [使用工具自动测试 Quickstart 文档](zh/development/test-quickstart.md)
+ - [想要开发新的组件?](zh/development/developing-component.md)
+ - [组件引用开发指南](zh/development/component_ref/component_ref.md)
+ - 想要修改proto文件或API定义？
+ - [如何基于proto文件生成代码、接口文档](zh/api_reference/how_to_generate_api_doc.md)
+ - [proto文件注释规范](zh/api_reference/comment_spec_of_proto.md)
+ - [新增API时的开发规范](zh/development/developing-api.md)
+ - [Layotto 四大 Github Workflows 说明](zh/development/github-workflows.md)
+ - [Layotto 命令行工具指南](zh/development/commands.md)
+ - 如何给 issue 打 label
+ - [新手任务 (good first issue) 的 label 规范](zh/development/label-spec.md)
+ - [发布手册](zh/development/release-guide.md)
+ - [待解决的问题](zh/development/problems-to-solve.md)
+- 社区
+ - [社区会议](zh/community/meeting.md)
+ - [SOFAStack & MOSN 社区角色说明](zh/community/governance.md)
+ - [Layotto社区晋升规则](zh/community/promote.md)
+ - [Layotto社区成员](zh/community/people.md)
+- 博客
+ - [蚂蚁云原生应用运行时的探索和实践 - ArchSummit 上海](zh/blog/exploration-and-practice-of-antcloud-native-application-runtime-archsummit-shanghai.md)
+ - [MOSN子项目Layotto：开启服务网格+应用运行时新篇章](zh/blog/mosn-subproject-layotto-opening-a-new-chapter-in-service-grid-application-runtime/index.md)
+ - 源码分析
+ - [启动流程](zh/blog/code/start_process/start_process.md)
+ - [处理 RPC 请求](zh/blog/code/layotto-rpc/index.md)
+ - [WebAssembly 相关](zh/blog/code/webassembly/index.md)
+ - [7层流量治理，接口限流](zh/blog/code/flowcontrol/flowcontrol_code_analyze.md)
+ - [源码解析 4层流量治理，tcp流量dump](zh/blog/tcpcopy_code_analyze.md)
+- [视频合集](zh/video/README.md)
diff --git a/docs/docs/api_reference/README.md b/docs/zh/api_reference/README.md
similarity index 100%
rename from docs/docs/api_reference/README.md
rename to docs/zh/api_reference/README.md
diff --git a/docs/docs/api_reference/comment_spec_of_proto.md b/docs/zh/api_reference/comment_spec_of_proto.md
similarity index 100%
rename from docs/docs/api_reference/comment_spec_of_proto.md
rename to docs/zh/api_reference/comment_spec_of_proto.md
diff --git a/docs/docs/api_reference/how_to_generate_api_doc.md b/docs/zh/api_reference/how_to_generate_api_doc.md
similarity index 100%
rename from docs/docs/api_reference/how_to_generate_api_doc.md
rename to docs/zh/api_reference/how_to_generate_api_doc.md
diff --git a/docs/blog/code/flowcontrol/flowcontrol_code_analyze.md b/docs/zh/blog/code/flowcontrol/flowcontrol_code_analyze.md
similarity index 100%
rename from docs/blog/code/flowcontrol/flowcontrol_code_analyze.md
rename to docs/zh/blog/code/flowcontrol/flowcontrol_code_analyze.md
diff --git a/docs/blog/code/layotto-rpc/index.md b/docs/zh/blog/code/layotto-rpc/index.md
similarity index 99%
rename from docs/blog/code/layotto-rpc/index.md
rename to docs/zh/blog/code/layotto-rpc/index.md
index 359a4e8e85..698ce36cac 100644
--- a/docs/blog/code/layotto-rpc/index.md
+++ b/docs/zh/blog/code/layotto-rpc/index.md
@@ -935,10 +935,7 @@ func (p *parser) recvMsg(maxReceiveMessageSize int) (pf payloadFormat, msg []byt
```
最终收到返回数据：
-
-```json
{"jsonrpc":"2.0","id":9527,"result":{"id":"113","name":"Moorse","age":30,"time":703394193,"sex":"MAN"}}
-```
## 总结
Layotto RPC 处理流程涉及 GRPC、Dapr、Mosn 等相关的知识，整体流程较长，不过单纯看 Layotto 针对 Mosn 抽象的轻量 RPC 框架还是比较清晰和简单的，与 Mosn 集成的方式也比较新颖，值得进一步研读。至此 Layotto RPC 请求处理就分析完了，时间有限，没有进行一些更全面和深入的剖析，如有纰漏之处，欢迎指正，联系方式：rayo.wangzl@gmail.com。另外在此也希望大家能踊跃参与源码分析和开源社区来，一起学习，共同进步。
diff --git a/docs/blog/code/start_process/start_process.md b/docs/zh/blog/code/start_process/start_process.md
similarity index 100%
rename from docs/blog/code/start_process/start_process.md
rename to docs/zh/blog/code/start_process/start_process.md
diff --git a/docs/blog/code/webassembly/index.md b/docs/zh/blog/code/webassembly/index.md
similarity index 100%
rename from docs/blog/code/webassembly/index.md
rename to docs/zh/blog/code/webassembly/index.md
diff --git a/docs/blog/exploration-and-practice-of-antcloud-native-application-runtime-archsummit-shanghai.md b/docs/zh/blog/exploration-and-practice-of-antcloud-native-application-runtime-archsummit-shanghai.md
similarity index 100%
rename from docs/blog/exploration-and-practice-of-antcloud-native-application-runtime-archsummit-shanghai.md
rename to docs/zh/blog/exploration-and-practice-of-antcloud-native-application-runtime-archsummit-shanghai.md
diff --git a/docs/blog/mosn-subproject-layotto-opening-a-new-chapter-in-service-grid-application-runtime/index.md b/docs/zh/blog/mosn-subproject-layotto-opening-a-new-chapter-in-service-grid-application-runtime/index.md
similarity index 100%
rename from docs/blog/mosn-subproject-layotto-opening-a-new-chapter-in-service-grid-application-runtime/index.md
rename to docs/zh/blog/mosn-subproject-layotto-opening-a-new-chapter-in-service-grid-application-runtime/index.md
diff --git a/docs/blog/tcpcopy_code_analyze.md b/docs/zh/blog/tcpcopy_code_analyze.md
similarity index 100%
rename from docs/blog/tcpcopy_code_analyze.md
rename to docs/zh/blog/tcpcopy_code_analyze.md
diff --git a/docs/docs/building_blocks/README.md b/docs/zh/building_blocks/README.md
similarity index 100%
rename from docs/docs/building_blocks/README.md
rename to docs/zh/building_blocks/README.md
diff --git a/docs/docs/building_blocks/actuator/actuator.md b/docs/zh/building_blocks/actuator/actuator.md
similarity index 89%
rename from docs/docs/building_blocks/actuator/actuator.md
rename to docs/zh/building_blocks/actuator/actuator.md
index f2601b1739..7efcba4451 100644
--- a/docs/docs/building_blocks/actuator/actuator.md
+++ b/docs/zh/building_blocks/actuator/actuator.md
@@ -1,4 +1,4 @@
-# 执行器 Http API
+# Actuator Http API
Layotto Actuator API提供健康检查、查看运行时元数据等功能，用于查看Layotto和app的健康状况、运行时元数据，支持集成进开源基础设施（例如可以集成进k8s健康检查）
@@ -50,7 +50,7 @@ var (
)
```
-注：默认情况下，接口只会返回Layotto的健康状态，如果希望接口也返回App的健康状态，需要开发一个回调App的插件。您可以参考[Actuator的设计文档](/docs/design/actuator/actuator-design-doc.md) ，或者直接联系我们，为您提供详细的解释。
+注：默认情况下，接口只会返回Layotto的健康状态，如果希望接口也返回App的健康状态，需要开发一个回调App的插件。您可以参考[Actuator的设计文档](zh/design/actuator/actuator-design-doc.md) ，或者直接联系我们，为您提供详细的解释。
### /actuator/health/readiness
@@ -77,7 +77,7 @@ GET,不需要传参
}
```
-注：默认情况下，接口只会返回Layotto的健康状态，如果希望接口也返回App的健康状态，需要开发一个回调App的插件。您可以参考[Actuator的设计文档](/docs/design/actuator/actuator-design-doc.md) ，或者直接联系我们，为您提供详细的解释。
+注：默认情况下，接口只会返回Layotto的健康状态，如果希望接口也返回App的健康状态，需要开发一个回调App的插件。您可以参考[Actuator的设计文档](zh/design/actuator/actuator-design-doc.md) ，或者直接联系我们，为您提供详细的解释。
## 2. 查询运行时元数据API
@@ -109,7 +109,7 @@ GET
Actuator采用插件化架构，您也可以按需添加自己的插件，让API返回您关注的运行时元数据
-注：默认情况下，接口只会返回Layotto的运行时元数据，如果希望接口也返回App的运行时元数据，需要开发一个回调App的插件。您可以参考[Actuator的设计文档](/docs/design/actuator/actuator-design-doc.md) ，或者直接联系我们，为您提供详细的解释。
+注：默认情况下，接口只会返回Layotto的运行时元数据，如果希望接口也返回App的运行时元数据，需要开发一个回调App的插件。您可以参考[Actuator的设计文档](zh/design/actuator/actuator-design-doc.md) ，或者直接联系我们，为您提供详细的解释。
## 3. API路径解释
@@ -139,4 +139,4 @@ Actuator API的路径采用restful风格，不同的Endpoint注册进Actuator后
```
## 4. API使用示例
-您可以查看[Quick start文档](/docs/start/actuator/start.md)
+您可以查看[Quick start文档](zh/start/actuator/start.md)
diff --git a/docs/i18n/en-US/docusaurus-plugin-content-docs/current/building_blocks/configuration/reference.md b/docs/zh/building_blocks/configuration/reference.md
similarity index 100%
rename from docs/i18n/en-US/docusaurus-plugin-content-docs/current/building_blocks/configuration/reference.md
rename to docs/zh/building_blocks/configuration/reference.md
diff --git a/docs/docs/building_blocks/file/file.md b/docs/zh/building_blocks/file/file.md
similarity index 97%
rename from docs/docs/building_blocks/file/file.md
rename to docs/zh/building_blocks/file/file.md
index 9ea6c6371d..4933dbd902 100644
--- a/docs/docs/building_blocks/file/file.md
+++ b/docs/zh/building_blocks/file/file.md
@@ -9,7 +9,7 @@ File api 用于实现文件操作。应用程序可以通过该接口对文件
File api定义在 [runtime.proto](https://github.com/mosn/layotto/blob/main/spec/proto/runtime/v1/runtime.proto) 。应用可以通过grpc调用
对应的File api，实现文件的操作。
-该接口在使用前需要进行配置。不同的文件系统可能配置不同，用户可根据自己的文件系统进行配置。比如OSS详细配置项可参考 [OSS组件文档](/docs/component_specs/file/oss.md)
+该接口在使用前需要进行配置。不同的文件系统可能配置不同，用户可根据自己的文件系统进行配置。比如OSS详细配置项可参考 [OSS组件文档](en/component_specs/file/oss.md)
### 例子
diff --git a/docs/docs/building_blocks/lock/reference.md b/docs/zh/building_blocks/lock/reference.md
similarity index 94%
rename from docs/docs/building_blocks/lock/reference.md
rename to docs/zh/building_blocks/lock/reference.md
index cc9e2965a3..ee392146d4 100644
--- a/docs/docs/building_blocks/lock/reference.md
+++ b/docs/zh/building_blocks/lock/reference.md
@@ -5,10 +5,10 @@
## 如何使用分布式锁 API
您可以通过grpc调用分布式锁 API，接口定义在[runtime.proto](https://github.com/mosn/layotto/blob/main/spec/proto/runtime/v1/runtime.proto) 中。
-使用前需要先对组件进行配置，详细的配置说明见[分布式锁组件文档](/docs/component_specs/lock/common.md)
+使用前需要先对组件进行配置，详细的配置说明见[分布式锁组件文档](zh/component_specs/lock/common.md)
### 使用示例
-Layotto client sdk封装了grpc调用的逻辑，使用sdk调用分布式锁 API的示例可以参考[快速开始：使用分布式锁API](/docs/start/lock/start.md)
+Layotto client sdk封装了grpc调用的逻辑，使用sdk调用分布式锁 API的示例可以参考[快速开始：使用分布式锁API](zh/start/lock/start.md)
### TryLock
@@ -77,4 +77,4 @@ req.LockOwner = uuid.New().String()
为避免文档和代码不一致，详细入参和返回值请参考[proto文件](https://github.com/mosn/layotto/blob/main/spec/proto/runtime/v1/runtime.proto)
## 为什么分布式锁 API被设计成这样
-如果您对实现原理、设计逻辑感兴趣，可以查阅[分布式锁API设计文档](/docs/design/lock/lock-api-design)
\ No newline at end of file
+如果您对实现原理、设计逻辑感兴趣，可以查阅[分布式锁API设计文档](zh/design/lock/lock-api-design)
\ No newline at end of file
diff --git a/docs/docs/building_blocks/pubsub/reference.md b/docs/zh/building_blocks/pubsub/reference.md
similarity index 96%
rename from docs/docs/building_blocks/pubsub/reference.md
rename to docs/zh/building_blocks/pubsub/reference.md
index cf97d0e503..56d092b4bb 100644
--- a/docs/docs/building_blocks/pubsub/reference.md
+++ b/docs/zh/building_blocks/pubsub/reference.md
@@ -20,10 +20,10 @@ Pub/Sub API 提供至少一次（at-least-once）的保证，并与各种消息
## 如何使用Pub/Sub API
您可以通过grpc调用Pub/Sub API，接口定义在[runtime.proto](https://github.com/mosn/layotto/blob/main/spec/proto/runtime/v1/runtime.proto) 中。
-使用前需要先对组件进行配置，详细的配置说明见[发布/订阅组件文档](/docs/component_specs/pubsub/common.md)
+使用前需要先对组件进行配置，详细的配置说明见[发布/订阅组件文档](zh/component_specs/pubsub/common.md)
### 使用示例
-Layotto client sdk封装了grpc调用的逻辑，使用sdk调用Pub/Sub API的示例可以参考[快速开始：使用Pub/Sub API](/docs/start/pubsub/start.md)
+Layotto client sdk封装了grpc调用的逻辑，使用sdk调用Pub/Sub API的示例可以参考[快速开始：使用Pub/Sub API](zh/start/pubsub/start.md)
### PublishEvent
用于发布事件到指定topic
diff --git a/docs/docs/building_blocks/rpc/reference.md b/docs/zh/building_blocks/rpc/reference.md
similarity index 100%
rename from docs/docs/building_blocks/rpc/reference.md
rename to docs/zh/building_blocks/rpc/reference.md
diff --git a/docs/docs/building_blocks/sequencer/reference.md b/docs/zh/building_blocks/sequencer/reference.md
similarity index 96%
rename from docs/docs/building_blocks/sequencer/reference.md
rename to docs/zh/building_blocks/sequencer/reference.md
index 51e7eade76..767eff90cc 100644
--- a/docs/docs/building_blocks/sequencer/reference.md
+++ b/docs/zh/building_blocks/sequencer/reference.md
@@ -36,9 +36,9 @@ select * from message order by message-id limit 100
## 如何使用Sequencer API
您可以通过grpc调用Sequencer API，接口定义在[runtime.proto](https://github.com/mosn/layotto/blob/main/spec/proto/runtime/v1/runtime.proto) 中。
-Layotto client sdk封装了grpc调用的逻辑，使用sdk调用Sequencer API的示例可以参考[快速开始：使用Sequencer API](/docs/start/sequencer/start.md)
+Layotto client sdk封装了grpc调用的逻辑，使用sdk调用Sequencer API的示例可以参考[快速开始：使用Sequencer API](zh/start/sequencer/start.md)
-使用前需要先对组件进行配置，详细的配置说明见[Sequencer组件文档](/docs/component_specs/sequencer/common.md)
+使用前需要先对组件进行配置，详细的配置说明见[Sequencer组件文档](zh/component_specs/sequencer/common.md)
### Get next unique id
diff --git a/docs/docs/building_blocks/state/reference.md b/docs/zh/building_blocks/state/reference.md
similarity index 97%
rename from docs/docs/building_blocks/state/reference.md
rename to docs/zh/building_blocks/state/reference.md
index 28768c527a..558ad18cbf 100644
--- a/docs/docs/building_blocks/state/reference.md
+++ b/docs/zh/building_blocks/state/reference.md
@@ -20,10 +20,10 @@ API支持批量CRUD操作，支持声明对并发安全和数据一致性的要
## 如何使用State API
您可以通过grpc调用State API，接口定义在[runtime.proto](https://github.com/mosn/layotto/blob/main/spec/proto/runtime/v1/runtime.proto) 中。
-使用前需要先对组件进行配置，详细的配置说明见[状态管理组件文档](/docs/component_specs/state/common.md)
+使用前需要先对组件进行配置，详细的配置说明见[状态管理组件文档](zh/component_specs/state/common.md)
### 使用示例
-Layotto client sdk封装了grpc调用的逻辑，使用sdk调用State API的示例可以参考[快速开始：使用State API](/docs/start/state/start.md)
+Layotto client sdk封装了grpc调用的逻辑，使用sdk调用State API的示例可以参考[快速开始：使用State API](zh/start/state/start.md)
### Save state
diff --git a/docs/docs/community/governance.md b/docs/zh/community/governance.md
similarity index 100%
rename from docs/docs/community/governance.md
rename to docs/zh/community/governance.md
diff --git a/docs/docs/community/meeting.md b/docs/zh/community/meeting.md
similarity index 100%
rename from docs/docs/community/meeting.md
rename to docs/zh/community/meeting.md
diff --git a/docs/docs/community/people.md b/docs/zh/community/people.md
similarity index 92%
rename from docs/docs/community/people.md
rename to docs/zh/community/people.md
index 3fa745a385..30df31686d 100644
--- a/docs/docs/community/people.md
+++ b/docs/zh/community/people.md
@@ -30,4 +30,4 @@ https://github.com/mosn/layotto/discussions/categories/announcements
## 晋升规则
-见[Layotto社区晋升规则](/docs/community/promote.md)
\ No newline at end of file
+见[Layotto社区晋升规则](zh/community/promote.md)
\ No newline at end of file
diff --git a/docs/docs/community/promote.md b/docs/zh/community/promote.md
similarity index 100%
rename from docs/docs/community/promote.md
rename to docs/zh/community/promote.md
diff --git a/docs/docs/component_specs/configuration/apollo.md b/docs/zh/component_specs/configuration/apollo.md
similarity index 96%
rename from docs/docs/component_specs/configuration/apollo.md
rename to docs/zh/component_specs/configuration/apollo.md
index 545676d000..709b484e66 100644
--- a/docs/docs/component_specs/configuration/apollo.md
+++ b/docs/zh/component_specs/configuration/apollo.md
@@ -2,7 +2,7 @@
## 配置项说明
示例：configs/config_apollo.json
-
+
| 字段 | 必填 | 说明 |
| --- | --- | --- |
diff --git a/docs/docs/component_specs/configuration/etcd.md b/docs/zh/component_specs/configuration/etcd.md
similarity index 100%
rename from docs/docs/component_specs/configuration/etcd.md
rename to docs/zh/component_specs/configuration/etcd.md
diff --git a/docs/docs/component_specs/configuration/nacos.md b/docs/zh/component_specs/configuration/nacos.md
similarity index 79%
rename from docs/docs/component_specs/configuration/nacos.md
rename to docs/zh/component_specs/configuration/nacos.md
index 4561f272df..1f8a8d3ead 100644
--- a/docs/docs/component_specs/configuration/nacos.md
+++ b/docs/zh/component_specs/configuration/nacos.md
@@ -4,20 +4,20 @@
示例：configs/config_nacos.json
-| 字段 | 必填 | 说明 |
-|-----------------------|-----|----------------------------------------------------------------------------------------------------------------------------------|
-| address | Y | nacos 服务地址，填写
value,_ := client.Get("key") |
| SaveConfiguration | 通过http. [update](https://www.apolloconfig.com/#/zh/usage/apollo-open-api-platform?id=_3211-%e4%bf%ae%e6%94%b9%e9%85%8d%e7%bd%ae%e6%8e%a5%e5%8f%a3) + [commit](https://www.apolloconfig.com/#/zh/usage/apollo-open-api-platform?id=_3213-%e5%8f%91%e5%b8%83%e9%85%8d%e7%bd%ae%e6%8e%a5%e5%8f%a3) 使用open API |
| DeleteConfiguration | 使用http. [delete](https://www.apolloconfig.com/#/zh/usage/apollo-open-api-platform?id=_3212-%e5%88%a0%e9%99%a4%e9%85%8d%e7%bd%ae%e6%8e%a5%e5%8f%a3) + [commit](https://www.apolloconfig.com/#/zh/usage/apollo-open-api-platform?id=_3213-%e5%8f%91%e5%b8%83%e9%85%8d%e7%bd%ae%e6%8e%a5%e5%8f%a3) 使用open API |
-| SubscribeConfiguration | https://github.com/apolloconfig/agollo/wiki/%E7%9B%91%E5%90%AC%E5%8F%98%E6%9B%B4%E4%BA%8B%E4%BB%B6 |
+| SubscribeConfiguration | https://github.com/apolloconfig/agollo/wiki/%E7%9B%91%E5%90%AC%E5%8F%98%E6%9B%B4%E4%BA%8B%E4%BB%B6 |
### 如何订阅指定应用的所有配置变更
diff --git a/docs/docs/design/faas/faas-poc-design.md b/docs/zh/design/faas/faas-poc-design.md
similarity index 71%
rename from docs/docs/design/faas/faas-poc-design.md
rename to docs/zh/design/faas/faas-poc-design.md
index 444d890be6..6b06e6cae6 100644
--- a/docs/docs/design/faas/faas-poc-design.md
+++ b/docs/zh/design/faas/faas-poc-design.md
@@ -1,15 +1,15 @@
-# FaaS设计文档
+## FaaS设计文档
-## 一、架构设计
+### 一、架构设计
-
+
整套FaaS的方案中，主要解决了以下两个问题：
1. 编译产生的 wasm 文件跟镜像之间的关系是什么？
- 1. 目标 wasm 文件最终被构建到一个普通镜像中，推送到 Dockerhub 里，拉取镜像的过程也跟原生的镜像保持一致，只不过实际运行时会把目标 wasm 文件从镜像中提取出来单独加载。
+ 1. 目标 wasm 文件最终被构建到一个普通镜像中，推送到 Dockerhub 里，拉取镜像的过程也跟原生的镜像保持一致，只不过实际运行时会把目标 wasm 文件从镜像中提取出来单独加载。
2. 如何让k8s管理部署 wasm 文件？
- 1. 基于k8s的生命周期管理及调度策略，结合Containerd的v2接口定义，自定义了Containerd-shim-layotto-v2插件，把容器运行时改造为Layotto Runtime，比如k8s创建容器的动作变成了加载 wasm 形态的函数并运行。
- 2. 得益于 WebAssembly 优秀的沙箱隔离环境，Layotto 作为基座可以加载运行多个 wasm 形态的函数，它们虽然都跑在一个进程里但互不影响，这种 nanoprocess 的思路相比于 docker 可以进一步充分利用资源。
+ 1. 基于k8s的生命周期管理及调度策略，结合Containerd的v2接口定义，自定义了Containerd-shim-layotto-v2插件，把容器运行时改造为Layotto Runtime，比如k8s创建容器的动作变成了加载 wasm 形态的函数并运行。
+ 2. 得益于 WebAssembly 优秀的沙箱隔离环境，Layotto 作为基座可以加载运行多个 wasm 形态的函数，它们虽然都跑在一个进程里但互不影响，这种 nanoprocess 的思路相比于 docker 可以进一步充分利用资源。
### 二、核心组件
diff --git a/docs/docs/design/file/file-design.md b/docs/zh/design/file/file-design.md
similarity index 100%
rename from docs/docs/design/file/file-design.md
rename to docs/zh/design/file/file-design.md
diff --git a/docs/docs/design/lifecycle/apply_configuration.md b/docs/zh/design/lifecycle/apply_configuration.md
similarity index 100%
rename from docs/docs/design/lifecycle/apply_configuration.md
rename to docs/zh/design/lifecycle/apply_configuration.md
diff --git a/docs/docs/design/lock/lock-api-design.md b/docs/zh/design/lock/lock-api-design.md
similarity index 99%
rename from docs/docs/design/lock/lock-api-design.md
rename to docs/zh/design/lock/lock-api-design.md
index 6e373cb0ad..4f01229dd0 100644
--- a/docs/docs/design/lock/lock-api-design.md
+++ b/docs/zh/design/lock/lock-api-design.md
@@ -1,4 +1,4 @@
-# 添加TryLock和Unlock API
+# 0. 太长，不看
添加TryLock和Unlock API.
续租API有争议，第一版不加入续租API
diff --git a/docs/docs/design/oss/design.md b/docs/zh/design/oss/design.md
similarity index 100%
rename from docs/docs/design/oss/design.md
rename to docs/zh/design/oss/design.md
diff --git a/docs/docs/design/pluggable/design.md b/docs/zh/design/pluggable/design.md
similarity index 95%
rename from docs/docs/design/pluggable/design.md
rename to docs/zh/design/pluggable/design.md
index ea8e2ca683..c5665bedc8 100644
--- a/docs/docs/design/pluggable/design.md
+++ b/docs/zh/design/pluggable/design.md
@@ -12,13 +12,13 @@
## 数据流架构
-
+
这是当前用户调用 sdk 开始的数据流向。虚线部分是与 pluggable component 主要参与的数据流。
### 组件发现
-
+
如上图所示，用户自定义组件启动 socket 服务，并将 socket 文件放到指定目录中。 layotto 启动时，会读取该目录中的所有 socket 文件（跳过文件夹），并建立 socket 连接。
diff --git a/docs/docs/design/pluggable/usage.md b/docs/zh/design/pluggable/usage.md
similarity index 96%
rename from docs/docs/design/pluggable/usage.md
rename to docs/zh/design/pluggable/usage.md
index e2477d812c..d5fa7b863a 100644
--- a/docs/docs/design/pluggable/usage.md
+++ b/docs/zh/design/pluggable/usage.md
@@ -51,4 +51,4 @@ hello
## 了解 Layotto 可插拔组件的实现原理
-如果您对实现原理感兴趣，或者想扩展一些功能，可以阅读[可插拔组件的设计文档](/docs/design/pluggable/design.md)
+如果您对实现原理感兴趣，或者想扩展一些功能，可以阅读[可插拔组件的设计文档](zh/design/pluggable/design.md)
diff --git a/docs/docs/design/pubsub/pubsub-api-and-compability-with-dapr-component.md b/docs/zh/design/pubsub/pubsub-api-and-compability-with-dapr-component.md
similarity index 95%
rename from docs/docs/design/pubsub/pubsub-api-and-compability-with-dapr-component.md
rename to docs/zh/design/pubsub/pubsub-api-and-compability-with-dapr-component.md
index 2ca0188f28..f0de81993c 100644
--- a/docs/docs/design/pubsub/pubsub-api-and-compability-with-dapr-component.md
+++ b/docs/zh/design/pubsub/pubsub-api-and-compability-with-dapr-component.md
@@ -12,13 +12,13 @@ Dapr的组件库可以直接复用；下文讨论sdk和proto是否复用、怎
### 面临的问题
1. dapr的sdk写死了调用接口的包名，名字里有dapr
- 
+ 
2. 我们会有差异化的需求，比如新字段、新API，如果直接使用 dapr.proto会不灵活
### 方案
#### 不复用sdk和proto；把proto文件剥离，路径中立
-
+
我们自己先定义个api-spec.proto，这个proto是dapr API的超集，并且路径名中立、没有layotto字样，基于这个proto自己开发个中立的RuntimeAPI sdk。
@@ -28,7 +28,7 @@ Dapr的组件库可以直接复用；下文讨论sdk和proto是否复用、怎
如果不好推的话，短期我们可以先在中立sdk里写个dapr适配器，用我们的sdk既能调dapr又能用layotto：
-
+
优点：
@@ -49,7 +49,7 @@ Dapr的组件库可以直接复用；下文讨论sdk和proto是否复用、怎
#### A. 只要API做变更、和Dapr不一样，就新开个方法名
-
+
新开方法名后，新老方法都得支持。**比如v1版是Dapr API版，v2版是扩展版本**
@@ -143,7 +143,7 @@ sidecar启动时调用app，一次性获取订阅关系。因此对启动顺序
一期先只支持开接口callback的形式，后续再优化加上声明式配置
## 2.3. Config Design
-
+
现在的app相关配置是放组件里的，后面要提出来、重构下Configuration API等代码（见下）。
@@ -173,7 +173,7 @@ Service Mesh时代的Control Plane只服务RPC，但Runtime API时代，组件
1. 不好做集群配置下发
1. 没法做组件权限管控配置(比如Dapr能限制app-id1只能访问topic_id1）
-
+
需要重构下原先组件逻辑
diff --git a/docs/docs/design/rpc/rpc_design_document.md b/docs/zh/design/rpc/rpc_design_document.md
similarity index 96%
rename from docs/docs/design/rpc/rpc_design_document.md
rename to docs/zh/design/rpc/rpc_design_document.md
index 4b9a7985db..9d0c7aaddb 100644
--- a/docs/docs/design/rpc/rpc_design_document.md
+++ b/docs/zh/design/rpc/rpc_design_document.md
@@ -1,6 +1,6 @@
-# RPC 设计文档
+RPC 设计文档
-## API 设计
+### API 设计
[layotto rpc API](https://github.com/mosn/layotto/blob/f70cdc619693ad762cf809daf0579403c341def1/spec/proto/runtime/v1/runtime.proto#L19https://github.com/mosn/layotto/blob/f70cdc619693ad762cf809daf0579403c341def1/spec/proto/runtime/v1/runtime.proto#L19) 与Dapr保持一致.
### 核心抽象
@@ -12,7 +12,7 @@
由于Mosn已经有了完整的RPC能力支持，layotto只提供了非常轻量的RPC框架
-
+
### Mosn集成
diff --git a/docs/docs/design/sequencer/design.md b/docs/zh/design/sequencer/design.md
similarity index 99%
rename from docs/docs/design/sequencer/design.md
rename to docs/zh/design/sequencer/design.md
index 5d9bebb028..c2550a014f 100644
--- a/docs/docs/design/sequencer/design.md
+++ b/docs/zh/design/sequencer/design.md
@@ -215,7 +215,7 @@ type Configuration struct {
另一个例子是[Leaf的设计](https://tech.meituan.com/2017/04/21/mt-leaf.htm) ，也是每个biz_tag对应一个max_id（Leaf的max_id就是我们的biggerThan)
-
+
**Q: 要不要在runtime层实现缓存?**
diff --git a/docs/docs/development/CONTRIBUTING.md b/docs/zh/development/CONTRIBUTING.md
similarity index 90%
rename from docs/docs/development/CONTRIBUTING.md
rename to docs/zh/development/CONTRIBUTING.md
index e02d6574bd..b3ec863b56 100644
--- a/docs/docs/development/CONTRIBUTING.md
+++ b/docs/zh/development/CONTRIBUTING.md
@@ -6,8 +6,8 @@ Layotto 基于 Apache 2.0 许可发布，遵循标准的 Github 开发流程，
- 首次提交 Pull Request 后，您需要先签署[贡献者许可协议（CLA）](http://cla.sofastack.tech/mosn)
- 优化您的 Pull Request，确保能通过自动化测试(CI)
- 如果是首次贡献者，您提交 Pull Request 是没法自动触发 CI 的，需要由项目维护者手动运行 CI. 这是 Github 的默认限制, 但您做过一次贡献、成为 contributor 后，再提新 PR 就能自动触发 CI 了。
- - CI 的详细说明见 [Layotto GitHub Workflows](github-workflows)
- - 为了方便开发， Layotto 有一套 make 脚本，可以在本地跑检查、跑测试，在本地启动好 docker 后，敲 `make all` 即可，详见[文档说明](/docs/development/commands)
+ - CI 的详细说明见 [Layotto GitHub Workflows](zh/development/github-workflows)
+ - 为了方便开发， Layotto 有一套 make 脚本，可以在本地跑检查、跑测试，在本地启动好 docker 后，敲 `make all` 即可，详见[文档说明](zh/development/commands)
- 由社区维护者来 code review
- code review 如果有修改意见，会在 PR 下留言
- code review 有两票 approve 后, PR 就可以合并
@@ -22,10 +22,10 @@ Layotto 基于 Apache 2.0 许可发布，遵循标准的 Github 开发流程，
4. 添加文档
5. 进行一些单元测试也会有很大帮助。
6. 请确保代码覆盖率不会降低。
-7. 确保提交 Pull Request 之前所有的测试能够正确通过。你可以本地启动好 docker 后，执行 `make all` 去格式化你的代码，进行风格测试，linter 规范测试，单元测试，以及集成测试。但是执行前[请先查看注意事项](/docs/development/commands)
+7. 确保提交 Pull Request 之前所有的测试能够正确通过。你可以本地启动好 docker 后，执行 `make all` 去格式化你的代码，进行风格测试，linter 规范测试，单元测试，以及集成测试。但是执行前[请先查看注意事项](zh/development/commands)
9. 按照 Github 工作流提交 Pull Request ，并遵循 Pull Request 的规则。
-> Layotto 提供了很多方便本地开发的命令行工具，请在[这里](commands)进行查阅
+> Layotto 提供了很多方便本地开发的命令行工具，请在[这里](zh/development/commands)进行查阅
## 版本命名约定
diff --git a/docs/docs/development/commands.md b/docs/zh/development/commands.md
similarity index 100%
rename from docs/docs/development/commands.md
rename to docs/zh/development/commands.md
diff --git a/docs/docs/development/component_ref/component_ref.md b/docs/zh/development/component_ref/component_ref.md
similarity index 83%
rename from docs/docs/development/component_ref/component_ref.md
rename to docs/zh/development/component_ref/component_ref.md
index bd060e708a..1090f75393 100644
--- a/docs/docs/development/component_ref/component_ref.md
+++ b/docs/zh/development/component_ref/component_ref.md
@@ -1,18 +1,18 @@
-# layotto组件引用
+## layotto组件引用
-## 背景
+### 背景
组件初始化的时候，需要引用其他组件的能力，比如sequencer组件初始化的时候需要从config组件读取相关的配置，以此实现组件之间的引用。
### 相关设计
目前只支持最需要被应用的两个组件类型:ConfigStore和SecretStore,即配置组件和秘钥组件。
-Ref接口设计，组件需实现此接口才能实现注入。
+Ref接口设计，组件需实现此接口才能实现注入。
```go
type SetComponent interface {
-SetConfigStore(cs configstores.Store) (err error)
-SetSecretStore(ss secretstores.SecretStore) (err error)
+ SetConfigStore(cs configstores.Store) (err error)
+ SetSecretStore(ss secretstores.SecretStore) (err error)
}
```
@@ -39,13 +39,13 @@ return nil
}
//fetch secret/config when component init
func (hw *HelloWorld) Init(config *hello.HelloConfig) error {
-hw.secretStore.GetSecret(secretstores.GetSecretRequest{
-Name: "dbPassword",
-})
-hw.config.Get(context.Background(),&configstores.GetRequest{
-Keys: []string{"dbAddress"},
-})
-return nil
+ hw.secretStore.GetSecret(secretstores.GetSecretRequest{
+ Name: "dbPassword",
+ })
+ hw.config.Get(context.Background(),&configstores.GetRequest{
+ Keys: []string{"dbAddress"},
+ })
+ return nil
}
```
diff --git a/docs/docs/development/contributing-doc.md b/docs/zh/development/contributing-doc.md
similarity index 89%
rename from docs/docs/development/contributing-doc.md
rename to docs/zh/development/contributing-doc.md
index 97361c79ac..ebc631f296 100644
--- a/docs/docs/development/contributing-doc.md
+++ b/docs/zh/development/contributing-doc.md
@@ -8,7 +8,7 @@
文档统一放在docs/目录下，其中docs/en存放英文文档，docs/zh存放中文文档。
-
+
## 2. 文档站点说明
docs/目录下的文件，会被自动部署到github pages，通过[docsify](https://docsify.js.org/#/) 渲染。
@@ -39,7 +39,7 @@ step 3. 打开 http://localhost:3000/ 查看文档站点。
### step 1. 新建 markdown 文档
当需要新增文档时，可以按目录结构新建文件夹、新建.md文件。比如想写分布式锁API的设计文档，就新建目录：
-
+
### step 2. 把文档加入侧边栏
新增文档、写完内容后，记得更新一下侧边栏哦。
@@ -60,14 +60,14 @@ step 3. 打开 http://localhost:3000/ 查看文档站点。
这里说的超链接是那种点了后会跳转到其他文档的链接，比如下面这种：
-
+
### 4.1. 错误的写法
如果你尝试用相对路径写超链接url，会发现在站点里点击他就会404：
-
+
-
+
### 4.2. 正确的写法
@@ -75,7 +75,7 @@ step 3. 打开 http://localhost:3000/ 查看文档站点。
a. 用相对于docs/目录的相对路径。例如：
-
+
b. 用完整的Url。例如：
@@ -86,7 +86,7 @@ see [runtime_config.json](https://github.com/mosn/layotto/blob/main/configs/runt
## 5. 图片目录与图片链接
图片放在docs/img/ 目录下。放这里是为了能让docsify站点能访问到：
-
+
文档中引用图片建议就用完整路径，免得遇到一堆乱七八糟的路径问题。
diff --git a/docs/docs/development/developing-api.md b/docs/zh/development/developing-api.md
similarity index 92%
rename from docs/docs/development/developing-api.md
rename to docs/zh/development/developing-api.md
index 0da9eb5f58..6930bddb58 100644
--- a/docs/docs/development/developing-api.md
+++ b/docs/zh/development/developing-api.md
@@ -9,9 +9,9 @@
A: 目前缺少使用文档，用户不好用，例如：
-
+
-
+
代码缺少注释，感兴趣的贡献者看不懂，例如 https://github.com/mosn/layotto/issues/112
@@ -45,11 +45,11 @@ A: **本规范只限制“新增Layotto API的pr需要有哪些东西”（比
提案需要包含以下内容：
- 需求分析
- - 为什么要做这个API
- - 定义需求的边界，哪些feature支持，哪些不支持
-- 市面上产品调研
+ - 为什么要做这个API
+ - 定义需求的边界，哪些feature支持，哪些不支持
+- 市面上产品调研
- grpc/http API设计
-- 组件API设计
+- 组件API设计
- 解释你的设计
一个优秀的提案示例：https://github.com/dapr/dapr/issues/2988
@@ -79,7 +79,7 @@ A: **本规范只限制“新增Layotto API的pr需要有哪些东西”（比
正例：[Dapr pub-sub quickstart](https://github.com/dapr/quickstarts/tree/v1.0.0/pub-sub) 在操作之前贴图解释下要做什么事情
-
+
反例：文档只写了操作步骤1234，用户看不懂操作这些想干啥
@@ -87,14 +87,14 @@ A: **本规范只限制“新增Layotto API的pr需要有哪些东西”（比
文档路径在"用户手册--接口文档"下，例如 State API的见 https://mosn.io/layotto/#/zh/api_reference/state/reference
>调研发现Dapr的使用文档较多，比如光State API就有:
->
+>
> https://docs.dapr.io/developing-applications/building-blocks/state-management/
-> https://docs.dapr.io/reference/api/state_api/
->
+> https://docs.dapr.io/reference/api/state_api/
+>
> https://docs.dapr.io/operations/components/setup-state-store/
->
+>
> https://docs.dapr.io/reference/components-reference/supported-state-stores/
->
+>
> 我们处于项目早期，可以轻一些
需要有：
@@ -102,12 +102,12 @@ A: **本规范只限制“新增Layotto API的pr需要有哪些东西”（比
##### when.什么场景适合用这个API
##### how.怎么用这个API
- 接口列表。例如：
-
-
-
+
+
+
列出来有哪些接口，一方面省的用户自己去翻proto、不知道哪些是相关API,一方面避免用户产生"这项目连接口文档都没有？！"的反感
- 关于接口的出入参：拿proto注释当接口文档
- 考虑到接口文档用中英文写要写两份、时间长了还有可能和代码不一致，因此建议不写接口文档，直接把proto注释写的足够详细、当接口文档。例如：
+考虑到接口文档用中英文写要写两份、时间长了还有可能和代码不一致，因此建议不写接口文档，直接把proto注释写的足够详细、当接口文档。例如：
```protobuf
// GetStateRequest is the message to get key-value states from specific state store.
@@ -124,7 +124,7 @@ message GetStateRequest {
// (optional) The metadata which will be sent to state store components.
map