celeborn/docs/configuration/quota.md
Fu Chen 516bdc7e08
[CELEBORN-877][DOC] Document on SBT
### What changes were proposed in this pull request?

As title

### Why are the changes needed?

As title

### Does this PR introduce _any_ user-facing change?

No

### How was this patch tested?

Manual test

Closes #1795 from cfmcgrady/sbt-docs.

Authored-by: Fu Chen <cfmcgrady@gmail.com>
Signed-off-by: Cheng Pan <chengpan@apache.org>
2023-08-11 12:17:55 +08:00

2.4 KiB

license
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Key Default Description Since
celeborn.quota.configuration.path <undefined> Quota configuration file path. The file format should be yaml. Quota configuration file template can be found under conf directory. 0.2.0
celeborn.quota.enabled true When true, before registering shuffle, LifecycleManager should check if current user have enough quota space, if cluster don't have enough quota space for current user, fallback to Spark's default shuffle 0.2.0
celeborn.quota.identity.provider org.apache.celeborn.common.identity.DefaultIdentityProvider IdentityProvider class name. Default class is org.apache.celeborn.common.identity.DefaultIdentityProvider. Optional values: org.apache.celeborn.common.identity.HadoopBasedIdentityProvider user name will be obtained by UserGroupInformation.getUserName; org.apache.celeborn.common.identity.DefaultIdentityProvider user name and tenant id are default values or user-specific values. 0.2.0
celeborn.quota.identity.user-specific.tenant default Tenant id if celeborn.quota.identity.provider is org.apache.celeborn.common.identity.DefaultIdentityProvider. 0.3.0
celeborn.quota.identity.user-specific.userName default User name if celeborn.quota.identity.provider is org.apache.celeborn.common.identity.DefaultIdentityProvider. 0.3.0
celeborn.quota.manager org.apache.celeborn.common.quota.DefaultQuotaManager QuotaManger class name. Default class is org.apache.celeborn.common.quota.DefaultQuotaManager. 0.2.0