Skip to content

Commit 4aa2a99

Browse files
authored
TOOLS-2579 Update eng.git for 24.4.1 (#70)
1 parent e797c51 commit 4aa2a99

15 files changed

Lines changed: 134 additions & 125 deletions

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,19 @@
66

77
<!--
88
Copyright 2019 Joyent, Inc.
9+
Copyright 2025 MNX Cloud, Inc.
910
-->
1011

11-
# eng: Joyent Engineering Guide
12+
# eng: Triton Engineering Guide
1213

1314
This repo serves two purposes: (1) It defines the guidelines and best
14-
practices for Joyent engineering work (this is the primary goal), and (2) it
15+
practices for Triton engineering work (this is the primary goal), and (2) it
1516
also provides boilerplate for a Triton (formerly known as SDC) project repo,
1617
giving you a starting point for many of the suggestion practices defined in
1718
the guidelines. This is especially true for node.js-based REST API projects.
1819

1920
**You probably want to be looking at the
20-
[actual Joyent engineering guide at docs/index.md](docs/index.md).**
21+
[actual Triton engineering guide at docs/index.md](docs/index.md).**
2122
This README.md is a template for repos to use.
2223

2324
**If you have cloned this repo to start a new project**
@@ -27,16 +28,16 @@ as the first paragraph of the introduction of your repo:
2728

2829
- For Triton-related repos:
2930
```
30-
This repository is part of the Joyent Triton project. See the [contribution
31-
guidelines](https://github.com/joyent/triton/blob/master/CONTRIBUTING.md)
31+
This repository is part of the Triton DataCenter project. See the [contribution
32+
guidelines](https://github.com/TritonDataCenter/triton/blob/master/CONTRIBUTING.md)
3233
and general documentation at the main
33-
[Triton project](https://github.com/joyent/triton) page.
34+
[Triton project](https://github.com/TritonDataCenter/triton) page.
3435
```
3536
- For Manta-related repos:
3637
```
37-
This repository is part of the Joyent Manta project. For contribution
38+
This repository is part of the Manta project. For contribution
3839
guidelines, issues, and general documentation, visit the main
39-
[Manta](http://github.com/joyent/manta) project page.
40+
[Manta](http://github.com/TritonDataCenter/manta) project page.
4041
```
4142
After the boilerplate paragraph, write a brief description about your repo.
4243

@@ -45,9 +46,9 @@ After the boilerplate paragraph, write a brief description about your repo.
4546

4647
To ensure maximum compatibility, release builds are performed on a build zone
4748
that is old enough to allow new and updated components to run on all supported
48-
platform images. If you are not using the Joyent Jenkins instance for
49+
platform images. If you are not using the Triton Jenkins instance for
4950
performing builds, you should build using an appropriate build zone. See
50-
[Build Zone Setup for Manta and Triton](https://github.com/joyent/triton/blob/master/docs/developer-guide/build-zone-setup.md).
51+
[Build Zone Setup for Manta and Triton](https://github.com/TritonDataCenter/triton/blob/master/docs/developer-guide/build-zone-setup.md).
5152

5253
Describe steps necessary for development here.
5354

@@ -63,7 +64,7 @@ Describe steps necessary for testing here.
6364

6465
## Documentation
6566

66-
[Joyent Engineering Guide is at docs/index.md](docs/index.md).
67+
[Triton Engineering Guide is at docs/index.md](docs/index.md).
6768

6869
To update the guidelines, edit "docs/index.md" and run `make docs`
6970
to update "docs/index.html". Works on either SmartOS or Mac OS X.
@@ -85,6 +86,6 @@ development data.
8586

8687
## License
8788

88-
"eng: Joyent Engineering Guide" is licensed under the
89+
"eng: Triton Engineering Guide" is licensed under the
8990
[Mozilla Public License version 2.0](http://mozilla.org/MPL/2.0/).
9091
See the file LICENSE.

docs/hybridimages.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ apisections:
1111

1212
<!--
1313
Copyright 2020 Joyent, Inc.
14-
Copyright 2022 MNX Cloud, Inc.
14+
Copyright 2025 MNX Cloud, Inc.
1515
-->
1616

17-
# Joyent Hybrid Images
17+
# Triton Hybrid Images
1818

1919
This document describes the best practices for HVM image creation such that they
2020
are compatible with the QEMU/KVM and bhyve hypervisors on SmartOS.
@@ -27,10 +27,10 @@ The key characteristics of a hybrid image are:
2727
locations in the device tree, perhaps with different model identifiers, serial
2828
numbers. etc.
2929
- Must configure networking using the [mdata
30-
protocol](https://eng.joyent.com/mdata/protocol.html) on the second serial
30+
protocol](https://eng.tritondatacenter.com/mdata/protocol.html) on the second serial
3131
port (`ttyS1`, `ttyb`, `COM2`, etc.).
3232
- Should take other actions as described in the [data
33-
dictionary](https://eng.joyent.com/mdata/datadict.html).
33+
dictionary](https://eng.tritondatacenter.com/mdata/datadict.html).
3434
- Should have an administrative port on the first serial port (`ttyS0`, `ttya`,
3535
`COM1`, etc.).
3636
- Should use virtio block and network devices.
@@ -57,7 +57,7 @@ The typical hybrid image creation process involves the following steps.
5757
installation. This sanity check likely involves looking for well-known
5858
markers in the log output described above.
5959
6. Generate an image, which is comprised of a zfs stream and a
60-
[manifest](https://github.com/joyent/sdc-imgapi/blob/master/docs/index.md#image-manifests).
60+
[manifest](https://github.com/TritonDataCenter/sdc-imgapi/blob/master/docs/index.md#image-manifests).
6161
7. Optionally upload to Manta and/or https://updates.tritondatacenter.com.
6262

6363
The steps described above are generally handled with automation. Steps 1, 2,
@@ -125,16 +125,16 @@ vmadm start $uuid
125125
126126
The following repositories follow the patterns described above.
127127
128-
* [mi-centos-hvm](https://github.com/joyent/mi-centos-hvm) for CentOS 6 - 8
129-
* [mi-debian-hvm](https://github.com/joyent/mi-debian-hvm) for Debian 8 - 10
128+
* [mi-centos-hvm](https://github.com/TritonDataCenter/mi-centos-hvm) for CentOS 6 - 8
129+
* [mi-debian-hvm](https://github.com/TritonDataCenter/mi-debian-hvm) for Debian 8 - 10
130130
131131
Each repo is intended to handle a family of distributions. The mi-centos-hvm
132132
repo probably implements the hard parts required for RHEL, Fedora, and other
133133
RHEL-derived distributions. Likewise, it should be straight-forward to add
134134
support for Ubuntu to mi-debian-hvm.
135135
136-
Each of those repositories has this ([eng](https://github.com/joyent/eng)) and
137-
[sdc-vmtools](https://github.com/joyent/sdc-vmtools) as subrepos. The eng repo
136+
Each of those repositories has this ([eng](https://github.com/TritonDataCenter/eng)) and
137+
[sdc-vmtools](https://github.com/TritonDataCenter/sdc-vmtools) as subrepos. The eng repo
138138
is home to common tools used for building the images and the sdc-vmtools repo
139139
is used for things that are added to the image.
140140
@@ -235,7 +235,7 @@ have specialized control over the boot loader, etc., additional arguments can be
235235
specified on the command line.
236236
237237
A key example of how this is used is in the [CentOS
238-
images](https://github.com/joyent/mi-centos-hvm/blob/master/create-image).Rather
238+
images](https://github.com/TritonDataCenter/mi-centos-hvm/blob/master/create-image).Rather
239239
than remastering the image to add the appropriate boot options, the installation
240240
media is mounted in the host and QEMU is started with options that specify the
241241
kernel, initrd, kernel command line, and a secondary CD which contains the

0 commit comments

Comments
 (0)