Skip to content

Commit 335b2f1

Browse files
authored
Merge pull request sonic-net#87 from rajendra-dendukuri/version_customization
Version customization
2 parents a1ba614 + 69599a8 commit 335b2f1

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

release_documents/SONiC_Package.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,12 @@
33
<br>
44
<br>
55
<br>
6-
# Broadcom SONiC
6+
7+
# Enterprise SONiC
8+
79
### Package Customization Guide
8-
#### Version 1.0
10+
11+
#### Version 1.1
912
<br>
1013
<br>
1114
<br>
@@ -22,12 +25,12 @@ A SONiC installer image (e.g sonic-broadcom-cloud-base.bin) is a self extracting
2225

2326
However, some customers who receive just the binary image from Broadcom would want some flexibility to influence some changes to the SONiC installer file.
2427

25-
This is made possible by creating a SONiC package which is also a self extracting binary image. The SONiC package file can be used to install SONIC image using ONIE and the sonic\_installer command just like the SONiC installer file. SONiC package file is typically named with *.pkg* file extension (e.g sonic-cloud-base.pkg)*.*
28+
This is made possible by creating a SONiC package which is also a self extracting binary image. The SONiC package file can be used to install SONIC image using ONIE and the sonic\_installer command just like the SONiC installer file. SONiC package file is typically named with *.pkg* file extension (e.g sonic-broadcom-cloud-base.pkg)*.*
2629

2730
A new tool *build\_pkg.sh* is available to create a SONiC package file. The *build\_pkg.sh* is available in the source code as
2831
*sonic-buildimage/build\_pkg.sh.*
2932

30-
Below is an example to create a SONiC package file to include a user provided *sonic\_branding.yml* which contains user defined Product Name.
33+
Below is an example to create a SONiC package file to include a user provided *sonic\_branding.yml* which contains user defined Product Name and software version.
3134

3235
**Command Usage:**
3336

@@ -40,10 +43,11 @@ build_pkg.sh target/sonic-broadcom-cloud-base.bin sonic_branding.yml
4043
```
4144
bash-4.2$ cat sonic_branding.yml
4245
product_name: SONiC by ACME Corporation Cloud Standard
46+
build_version: 'acme-p.q.r'
4347
4448
bash-4.2$ build_pkg.sh target/sonic-broadcom-cloud-base.bin sonic_branding.yml
4549
Creating a package file to combine target/sonic-broadcom-cloud-base.bin and sonic_branding.yml
4650
Successfully created package file: sonic-broadcom-cloud-base.pkg
4751
```
4852
When user installs the sonic-broadcom-cloud-base.pkg, the sonic\_branding.yml in /etc/sonic directory of the image is replaced with the one provided by user and thus *show version* shows the product
49-
name chosen by the user.
53+
name and version string chosen by the user.

0 commit comments

Comments
 (0)