Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Stablize Ignition spec 3.5 #1922

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

madhu-pillai
Copy link
Contributor

@madhu-pillai madhu-pillai commented Aug 14, 2024

https://issues.redhat.com/browse/COS-2870

I've completed the changes in ignition to stablize 3.5.0 from the issue template till Update Docs https://github.com/coreos/ignition/blob/main/.github/ISSUE_TEMPLATE/stabilize-checklist.md .
Kindly review and suggest for any further changes.

Fixes: #1925

@prestist
Copy link
Collaborator

prestist commented Aug 19, 2024

@madhu-pillai Thank you for doing this;

Would you mind updating this checklist #1925 with the steps completed?

I dont think I could do a stablization without having a checkbox lol too many steps.

@madhu-pillai
Copy link
Contributor Author

HI @prestist ,
I've updated the checklist that i finished in the issues.

@prestist
Copy link
Collaborator

prestist commented Aug 27, 2024

@madhu-pillai awesome, so note; there are external packages that need to be updated after this lands and then additionally we need to stabilize ignition in butane | ignition-config-rs | ign-converter |. see #1553 (comment)

@prestist
Copy link
Collaborator

Ok @madhu-pillai I have reviewed your changes, it's a bit intense in one commit. Is there any way I could ask you to follow a similar structure to this

https://github.com/coreos/ignition/pull/1558/commits

To my eye; I dont see anything wrong with your PR however due to the sensitive nature I want to make sure before approving. Sorry for the difficult ask but its not very consumable atm.

@madhu-pillai
Copy link
Contributor Author

Will do that...

@madhu-pillai madhu-pillai force-pushed the bump_ignition_3.5 branch 2 times, most recently from c9ce1c5 to bed9df1 Compare August 30, 2024 18:28
Copy link
Collaborator

@prestist prestist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gennerally lgtm, small changes and a question;
Are we wanting CEX to be considered stable? @travier

// See the License for the specific language governing permissions and
// limitations under the License.

package v3_6_experimental
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Commit name is wrong; should be

config: copy v3_5 to v3_6_experimental

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Im not sure why but because stabilizing and renaming happened at the same time there seems to be a very large diff. It makes everything look like new content (not a simple rename) i.e look here 86d17f1

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, Its because when looking at it commit by commit the removal of the files was at a separate point.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it because i did the mv without git?

@@ -384,7 +384,7 @@ root:
desc: describes the IBM Crypto Express (CEX) card configuration for the luks device.
children:
- name: enabled
desc: whether or not to use a CEX secure key to encrypt the luks device.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should not make this change as a part of the pr, it makes it confusing. this can be fixed by the already opened external pr.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@madhu-pillai
Copy link
Contributor Author

Hi, The moment before the push, the test was success. not sure why it failed on the go part.

@prestist
Copy link
Collaborator

You might need to rebase- golang 1.23 is having issues with the ./build script and there was a changed committed to main to fix it.

@madhu-pillai
Copy link
Contributor Author

Hi, I did rebase before the push and it is upto date.

[root@a3elp53 ignition]# git remote -v
origin	[email protected]:madhu-pillai/ignition.git (fetch)
origin	[email protected]:madhu-pillai/ignition.git (push)
upstream	https://github.com/coreos/ignition.git (fetch)
upstream	https://github.com/coreos/ignition.git (push)
[root@a3elp53 ignition]# git push origin bump_ignition_3.5 -f
Everything up-to-date 
a2079161 (HEAD -> bump_ignition_3.5, origin/bump_ignition_3.5) config: moved v3_5_experimental
b5d591ae docs: update for spec stablization
5cba417c docs: shuffle for spec stablization
e76023a8 tests: update for new experimental spec
846d3f7f *: update to v3_6_experimental spec
624e6cc4 config: copy v3_5 to v3_6_experimental and adapt for new experimental spec
6a978528 config: rename v3_5_experimental to v3_5 and stablize
39aca3c5 (upstream/main) Merge pull request #1942 from k0tran/patch-1
54afa542 docs: add bug fix entry for PR #1942
cd1c2cce Merge pull request #1940 from tormath1/tormath1/ignition
6eb35ed4 dracut: add dependency network to ignition-mount.service

@prestist
Copy link
Collaborator

@madhu-pillai it looks like unit-tests are failing; are you saying they are passing locally for you?

@madhu-pillai
Copy link
Contributor Author

Hi @prestist , Yes, the test pass locally.

[root@a3elp53 ignition]# git status
On branch bump_ignition_3.5
Your branch is up to date with 'origin/bump_ignition_3.5'.

nothing to commit, working tree clean
[root@a3elp53 ignition]# ./test
Checking for license headers...
Using version from git: v2.19.0-82-g045b6800
Building ignition...
Building ignition-validate...
Checking gofix...
go fix: warning: no cgo types: exit status 1
go fix: warning: no cgo types: exit status 1
go fix: warning: no cgo types: exit status 1
go fix: warning: no cgo types: exit status 1
go fix: warning: no cgo types: exit status 1
go fix: warning: no cgo types: exit status 1
go fix: warning: no cgo types: exit status 1
go fix: warning: no cgo types: exit status 1
go fix: warning: no cgo types: exit status 1
go fix: warning: no cgo types: exit status 1
go fix: warning: no cgo types: exit status 1
go fix: warning: no cgo types: exit status 1
go fix: warning: no cgo types: exit status 1
go fix: warning: no cgo types: exit status 1
go fix: warning: no cgo types: exit status 1
go fix: warning: no cgo types: exit status 1
Checking gofmt...

Checking govet...
Running tests...
?   	github.com/coreos/ignition/v2/config/doc	[no test files]
ok  	github.com/coreos/ignition/v2/config	(cached)	coverage: 0.0% of statements
ok  	github.com/coreos/ignition/v2/config/merge	(cached)	coverage: 93.6% of statements
?   	github.com/coreos/ignition/v2/config/shared/errors	[no test files]
?   	github.com/coreos/ignition/v2/config/shared/parse	[no test files]
?   	github.com/coreos/ignition/v2/config/shared/validations	[no test files]
?   	github.com/coreos/ignition/v2/config/shared	[no test files]
ok  	github.com/coreos/ignition/v2/config/translate	(cached)	coverage: 75.0% of statements
?   	github.com/coreos/ignition/v2/config/util	[no test files]
ok  	github.com/coreos/ignition/v2/config/v3_0	(cached)	coverage: 90.0% of statements
ok  	github.com/coreos/ignition/v2/config/v3_0/types	(cached)	coverage: 59.8% of statements
ok  	github.com/coreos/ignition/v2/config/v3_1	(cached)	coverage: 91.3% of statements
ok  	github.com/coreos/ignition/v2/config/v3_1/translate	(cached)	coverage: 100.0% of statements
ok  	github.com/coreos/ignition/v2/config/v3_1/types	(cached)	coverage: 61.9% of statements
ok  	github.com/coreos/ignition/v2/config/v3_2	(cached)	coverage: 91.3% of statements
ok  	github.com/coreos/ignition/v2/config/v3_2/translate	(cached)	coverage: 100.0% of statements
ok  	github.com/coreos/ignition/v2/config/v3_2/types	(cached)	coverage: 56.5% of statements
ok  	github.com/coreos/ignition/v2/config/v3_3	(cached)	coverage: 91.3% of statements
ok  	github.com/coreos/ignition/v2/config/v3_3/translate	(cached)	coverage: 100.0% of statements
ok  	github.com/coreos/ignition/v2/config/v3_3/types	(cached)	coverage: 58.9% of statements
ok  	github.com/coreos/ignition/v2/config/v3_4	(cached)	coverage: 91.3% of statements
ok  	github.com/coreos/ignition/v2/config/v3_4/translate	(cached)	coverage: 100.0% of statements
ok  	github.com/coreos/ignition/v2/config/v3_4/types	(cached)	coverage: 62.5% of statements
ok  	github.com/coreos/ignition/v2/config/v3_5	(cached)	coverage: 91.3% of statements
ok  	github.com/coreos/ignition/v2/config/v3_5/translate	(cached)	coverage: 100.0% of statements
ok  	github.com/coreos/ignition/v2/config/v3_5/types	(cached)	coverage: 62.1% of statements
ok  	github.com/coreos/ignition/v2/config/v3_6_experimental	(cached)	coverage: 91.3% of statements
ok  	github.com/coreos/ignition/v2/config/v3_6_experimental/translate	(cached)	coverage: 100.0% of statements
ok  	github.com/coreos/ignition/v2/config/v3_6_experimental/types	(cached)	coverage: 62.1% of statements
ok  	github.com/coreos/ignition/v2/config/validate	(cached)	coverage: 90.9% of statements
?   	github.com/coreos/ignition/v2/internal	[no test files]
?   	github.com/coreos/ignition/v2/internal/apply	[no test files]
?   	github.com/coreos/ignition/v2/internal/as_user	[no test files]
?   	github.com/coreos/ignition/v2/internal/distro	[no test files]
?   	github.com/coreos/ignition/v2/internal/doc	[no test files]
?   	github.com/coreos/ignition/v2/internal/earlyrand	[no test files]
?   	github.com/coreos/ignition/v2/internal/exec	[no test files]
?   	github.com/coreos/ignition/v2/internal/exec/stages	[no test files]
?   	github.com/coreos/ignition/v2/internal/exec/stages/disks	[no test files]
?   	github.com/coreos/ignition/v2/internal/exec/stages/fetch	[no test files]
ok  	github.com/coreos/ignition/v2/internal/exec/stages/fetch_offline	(cached)	coverage: 72.1% of statements
ok  	github.com/coreos/ignition/v2/internal/exec/stages/files	(cached)	coverage: 2.6% of statements
?   	github.com/coreos/ignition/v2/internal/exec/stages/kargs	[no test files]
?   	github.com/coreos/ignition/v2/internal/exec/stages/mount	[no test files]
?   	github.com/coreos/ignition/v2/internal/exec/stages/umount	[no test files]
ok  	github.com/coreos/ignition/v2/internal/exec/util	(cached)	coverage: 2.0% of statements
?   	github.com/coreos/ignition/v2/internal/log	[no test files]
?   	github.com/coreos/ignition/v2/internal/platform	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/akamai	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/aliyun	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/applehv	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/aws	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/azure	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/azurestack	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/cloudstack	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/cmdline	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/digitalocean	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/exoscale	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/file	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/gcp	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/hetzner	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/hyperv	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/ibmcloud	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/metal	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/nutanix	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/openstack	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/packet	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/powervs	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/proxmoxve	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/qemu	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/scaleway	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/system	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/util	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/virtualbox	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/kubevirt	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/vultr	[no test files]
?   	github.com/coreos/ignition/v2/internal/providers/zvm	[no test files]
ok  	github.com/coreos/ignition/v2/internal/providers/vmware	(cached)	coverage: 58.9% of statements
?   	github.com/coreos/ignition/v2/internal/register	[no test files]
ok  	github.com/coreos/ignition/v2/internal/registry	(cached)	coverage: 90.0% of statements
?   	github.com/coreos/ignition/v2/internal/sgdisk	[no test files]
ok  	github.com/coreos/ignition/v2/internal/resource	(cached)	coverage: 12.7% of statements
?   	github.com/coreos/ignition/v2/internal/state	[no test files]
?   	github.com/coreos/ignition/v2/internal/systemd	[no test files]
?   	github.com/coreos/ignition/v2/internal/util/tools/docs	[no test files]
?   	github.com/coreos/ignition/v2/internal/version	[no test files]
?   	github.com/coreos/ignition/v2/validate	[no test files]
ok  	github.com/coreos/ignition/v2/internal/util	(cached)	coverage: 33.9% of statements
Checking docs...
Found 10 sections in: docs/examples.md
Found 19 sections in: docs/migrating-configs.md
Success

@travier
Copy link
Member

travier commented Sep 20, 2024

Gennerally lgtm, small changes and a question; Are we wanting CEX to be considered stable? @travier

Yes, this is why we need this spec stabilization.

@travier
Copy link
Member

travier commented Sep 20, 2024

It's hard to review this as is as you need to strictly follow the steps and create intermediary commits to make the changes visible.

I'm re-splitting the changes.

See: #1558

We might also have to look at if we need to re-add: 7cff68f (#1558)

@travier
Copy link
Member

travier commented Sep 20, 2024

Let's see if this passes tests. I'll have to review it again.

@madhu-pillai
Copy link
Contributor Author

The test got passed when i push the PR as single commit as well as later i split the PR. Then i push the PR after the correction in config/doc/ignition.yaml and it keep fails in unit test. But the test runs fine at locally.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Stablize 3.5.0
3 participants