- What's New
- Function Overview
- Service Overview
- Billing
- Getting Started
- User Guide
- Best Practices
-
Developer Guide
- Overview
- Using Native kubectl (Recommended)
- Namespace and Network
- Pod
- Label
- Deployment
- EIPPool
- EIP
- Pod Resource Monitoring Metric
- Collecting Pod Logs
- Managing Network Access Through Service and Ingress
- Using PersistentVolumeClaim to Apply for Persistent Storage
- ConfigMap and Secret
- Creating a Workload Using Job and Cron Job
- YAML Syntax
-
API Reference
- Before You Start
- Calling APIs
- Getting Started
- Proprietary APIs
-
Kubernetes APIs
- ConfigMap
- Pod
- StorageClass
- Service
-
Deployment
- Querying All Deployments
- Deleting All Deployments in a Namespace
- Querying Deployments in a Namespace
- Creating a Deployment
- Deleting a Deployment
- Querying a Deployment
- Updating a Deployment
- Replacing a Deployment
- Querying the Scaling Operation of a Specified Deployment
- Updating the Scaling Operation of a Specified Deployment
- Replacing the Scaling Operation of a Specified Deployment
- Querying the Status of a Deployment
- Ingress
- OpenAPIv2
- VolcanoJob
- Namespace
- ClusterRole
- Secret
- Endpoint
- ResourceQuota
- CronJob
-
API groups
- Querying API Versions
- Querying All APIs of v1
- Querying an APIGroupList
- Querying APIGroup (/apis/apps)
- Querying APIs of apps/v1
- Querying an APIGroup (/apis/batch)
- Querying an APIGroup (/apis/batch.volcano.sh)
- Querying All APIs of batch.volcano.sh/v1alpha1
- Querying All APIs of batch/v1
- Querying All APIs of batch/v1beta1
- Querying an APIGroup (/apis/crd.yangtse.cni)
- Querying All APIs of crd.yangtse.cni/v1
- Querying an APIGroup (/apis/extensions)
- Querying All APIs of extensions/v1beta1
- Querying an APIGroup (/apis/metrics.k8s.io)
- Querying All APIs of metrics.k8s.io/v1beta1
- Querying an APIGroup (/apis/networking.cci.io)
- Querying All APIs of networking.cci.io/v1beta1
- Querying an APIGroup (/apis/rbac.authorization.k8s.io)
- Querying All APIs of rbac.authorization.k8s.io/v1
- Event
- PersistentVolumeClaim
- RoleBinding
- StatefulSet
- Job
- ReplicaSet
- Data Structure
- Permissions Policies and Supported Actions
- Appendix
- Out-of-Date APIs
- Change History
-
FAQs
- Product Consulting
-
Basic Concept FAQs
- What Is CCI?
- What Are the Differences Between Cloud Container Instance and Cloud Container Engine?
- What Is an Environment Variable?
- What Is a Service?
- What Is Mcore?
- What Are the Relationships Between Images, Containers, and Workloads?
- What Are Kata Containers?
- Can kubectl Be Used to Manage Container Instances?
- What Are Core-Hours in CCI Resource Packages?
- Workload Abnormalities
-
Container Workload FAQs
- Why Service Performance Does Not Meet the Expectation?
- How Do I Set the Quantity of Instances (Pods)?
- How Do I Check My Resource Quotas?
- How Do I Set Probes for a Workload?
- How Do I Configure an Auto Scaling Policy?
- What Do I Do If the Workload Created from the sample Image Fails to Run?
- How Do I View Pods After I Call the API to Delete a Deployment?
- Why an Error Is Reported When a GPU-Related Operation Is Performed on the Container Entered by Using exec?
- Can I Start a Container in Privileged Mode When Running the systemctl Command in a Container in a CCI Cluster?
- Why Does the Intel oneAPI Toolkit Fail to Run VASP Tasks Occasionally?
- Why Are Pods Evicted?
- Why Is the Workload Web-Terminal Not Displayed on the Console?
- Why Are Fees Continuously Deducted After I Delete a Workload?
-
Image Repository FAQs
- Can I Export Public Images?
- How Do I Create a Container Image?
- How Do I Upload Images?
- Does CCI Provide Base Container Images for Download?
- Does CCI Administrator Have the Permission to Upload Image Packages?
- What Permissions Are Required for Uploading Image Packages for CCI?
- What Do I Do If Authentication Is Required During Image Push?
-
Network Management FAQs
- How Do I View the VPC CIDR Block?
- Does CCI Support Load Balancing?
- How Do I Configure the DNS Service on CCI?
- Does CCI Support InfiniBand (IB) Networks?
- How Do I Access a Container from a Public Network?
- How Do I Access a Public Network from a Container?
- What Do I Do If Access to a Workload from a Public Network Fails?
- What Do I Do If Error 504 Is Reported When I Access a Workload?
- What Do I Do If the Connection Timed Out?
- Storage Management FAQs
- Log Collection
- Account
- SDK Reference
- Videos
- General Reference
Copied.
YAML Syntax
YAML is a simple and powerful language. It is designed to make the language easy to read.
Basic Syntax Rules
- Characters are case-sensitive.
- Indentation is used for denoting structure.
- Only spaces can be used for indentation, but tab characters are not allowed.
- The specific number of spaces in the indentation is unimportant as long as parallel elements have the same left justification.
- Comments begin with the number sign (#).
Data Types Supported by YAML
- Object: A set of key-value pairs, which is also known as maps, hashes, or dictionaries.
- Array: A group of values arranged in sequence, which is also known as sequence or list.
- Scalar: A single and irreducible value, which is the minimum data unit.
Object
An object is a group of key-value pairs. For key: value, the colon (:) must be followed by a space or newline character. The valid expression is as follows:
animal: pets plant: tree
You can also write multiple key-value pairs into an inline object.
hash: {name: Steve, foo: bar}
However, an error occurs in the following scenario:
foo: somebody said I should put a colon here: so I did windows_drive: c:
To resolve the issue, you can enclose values in single quotation marks (' ') as follows:
foo: 'somebody said I should put a colon here: so I did' windows_drive: 'c:'
Array
An array is represented by a hyphen (-) and space. The valid expression is as follows:
animal: - Cat - Dog - Goldfish
You can also use the inline representation.
animal: [Cat, Dog, Goldfish]
Objects and arrays can be used in combination to form a composite structure.
languages: - Ruby - Perl - Python websites: YAML: yaml.org Ruby: ruby-lang.org Python: python.org Perl: use.perl.org
Scalar
Scalars include strings, Boolean values, integers, floats, null, time, and dates.
- String:
By default, a string is not enclosed in quotation marks.
str:This_is_a_line
If a string contains spaces or special characters, the string needs to be enclosed in quotation marks.
str: 'content: a string'
Both single and double quotation marks can be used. The difference between them is that the former can identify escape characters while the latter cannot convert special characters.
s1: 'content:\n a string' s2: "content:\n a string"
If there is a single quotation mark between two single quotation marks, ensure that two consecutive single quotation marks are used to achieve conversion.
str: 'labor''s day'
Strings can be written into multiple lines. The lines except the first line must be indented with one space. The newline character will be converted to a space.
str: This_is a_multi_line
- Integer:
int_value: 314
- Float:
float_value: 3.14
- Null:
parent: ~
- Time
The time is in the ISO8601 format.
iso8601: 2018-12-14t21:59:43.10-05:00
- Date:
The date is in the compound ISO8601 format: year-month-day.
date: 1976-07-31
Special Symbols
- Three hyphens (---) indicate the start of a YAML file. Three periods (...) indicate the end of a YAML file.
--- # A list of delicious fruits - Apple - Orange - Strawberry - Mango ...
- You can use two exclamation marks (!!) to forcibly convert an integer, a float, or a Boolean value.
strbool: !!str true strint: !!str 10
- For a string occupying multiple lines, you can use a literal block scalar (|) to preserve newlines or folded block scalar (>) to fold newlines. The two symbols are often used in the character strings in YAML files.
this: | Foo Bar that: > Foo Bar
The corresponding objects are as follows:
{ this: 'Foo\nBar\n', that: 'Foo Bar\n' }
It is recommended that you use "|" to meet the requirements of most scenarios.
Comment
YAML supports comments. This is an advantage of YAML compared with JSON.
Comments in YAML files begin with the number sign (#), as shown in the following:
languages: - Ruby # Ruby programming language - Go # Go programming language - Python # Python programming language
Reference Documents
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot