-
Notifications
You must be signed in to change notification settings - Fork 367
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
feat: [M3-6146] - Add User Data to Linode Rebuild flow #8850
feat: [M3-6146] - Add User Data to Linode Rebuild flow #8850
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
packages/manager/src/features/linodes/LinodesDetail/LinodeRebuild/RebuildFromImage.tsx
Outdated
Show resolved
Hide resolved
packages/manager/src/features/linodes/LinodesDetail/LinodeRebuild/RebuildFromImage.tsx
Outdated
Show resolved
Hide resolved
|
packages/manager/src/features/linodes/LinodesDetail/LinodeRebuild/RebuildFromImage.tsx
Outdated
Show resolved
Hide resolved
renderCheckbox={() => ( | ||
<Box> | ||
<CheckBox | ||
checked={reuseUserData} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we use a more descriptive variable name for reuseUserData
? Maybe something like shouldReuseUserData
? reuseUserData sounds more like a function name to me.
Also what makes us need to use state here over the formik form?
checked={reuseUserData} | |
checked={reuseUserData} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With regards to the state for checked
, since we wouldn't want to submit shouldReuseUserData
as part of the payload, I think we're in a similar position here as we were in for AccessKeyDrawer.tsx
// If no user data has been added, do not include the metadata property in the payload. | ||
if (!userData && !shouldReuseUserData) { | ||
delete params['metadata']; | ||
} | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, looks like I misunderstood the rebuild endpoint 😅
- By default, if no user data has been added/user hasn't clicked on the re-use checkbox, we should send user_data as null to the rebuild endpoint
- If the user checks the reuse checkbox, then we should not send any metadata/user data
- If metadata/user data is given, we send user_data encoded in base64
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be good to go now 🚀
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall, it looks great. I only have a few comments left related to the naming of JSX elements.
|
||
return ( | ||
<Accordion | ||
heading={accordionHeading} | ||
style={{ marginTop: 24 }} | ||
style={{ marginTop: renderNotice && renderCheckbox ? 0 : 24 }} // for now, these props can be taken as an indicator we're in the Rebuild flow. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could also access props within Styled components to conditionally apply styles.
Example:
const StyledAccordion = styled(Accordion)`
margin-top: ${({ renderNotice, renderCheckbox }) => (renderNotice && renderCheckbox ? 0 : 24)};
&:before {
display: none;
}
`;
<StyledAccordion
heading={accordionHeading}
renderNotice={renderNotice}
renderCheckbox={renderCheckbox}
....
>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you do down that route, for code readability I recommend using only one top-level function, especially if in the future we need to add to this:
const Accordion = styled(AccordionComponent)(({ renderNotice, renderCheckbox }) => ({
marginTop: renderNotice && renderCheckbox ? 0 : 24,
'&:before': {
display: 'none',
},
}));
packages/manager/src/features/linodes/LinodesDetail/LinodeRebuild/RebuildFromImage.tsx
Show resolved
Hide resolved
…functions returning JSX
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚀
* add user data accordion to linode create * display accordion if image supports cloud-init * update linode create payload * check image for cloud-init * Add validation warning for user data Co-authored-by: Hussain Khalil <hussain@sanpilot.co> * feat: [M3-6149] - Add Cloud Init checkbox to Image Capture/Create flow (#8807) * Add checkbox to Capture Image form * Update request to support cloud_init * Fix controlled component error where checkbox is undefined * Update image validation and types interface for cloud_init * (Debugging an undefined value in createImage request) * Add cloud_init to redux create fn params to include in request * Move checkbox state to ImageCreate so value persists across tabs; code cleanup * Code clean up * Fix comment referencing cloud-init for naming consistency * Update CheckBox tooltip: allow interactivity, minor styling fix * Add final tooltip copy for now * Revert "Merge branch 'develop' into feature/metadata" This reverts commit 8be0c73, reversing changes made to a5e1b25. * feat: [M3-6150] - Add Cloud-init compatible check box to Image Upload flow (#8800) * Add Cloud-init compatible check box * use Checkbox component and reduce space between label and tooltip icon * add new fileds for image create * code cleanup * make cloud_in as optional * Code cleanup * Copy update and PR feedback * code cleanup * Enable interactive to tooltip * feat: [M3 6143] - Add User Data Accordion to Linode Create page (#8811) ## Description 📝 Add User Data accordion to the Linode Create flow so that a user can configure their Linode using cloud-init. ## How to test 🧪 Testing Create via Distribution 1. Point to the dev environment (you might also need additional account setup, reach out for more info) 2. Navigate to the Linode create page http://localhost:3000/linodes/create 3. Select a distribution that supports cloud-init - Arch Linux, Cent OS 7, and Ubuntu 16.04 LTS have been marked as cloud-init compatible for testing purposes 4. If the distribution supports cloud-init, you should see an `Add User Data` accordion - If the distribution doesn't support cloud-init, you should _not_ see the accordion 5. Enter some text (can be anything) into the User Data input field and fill out the rest of the required Linode Create fields 6. Click on Create Linode and observe the POST payload to `/linode/instances`. You should see a metadata field with the user_data object - If you did not enter anything into the User Data input, you should _not_ see any metadata field in the payload. - You can just block the network request to `/linode/instances` and check the payload w/o actually creating another Linode 7. There are no changes to the API response so you will not see a metadata field returned Testing Create via Image - Navigate to the Linode Create Image tab http://localhost:3000/linodes/create?type=Images - Select an image that supports cloud-init - You can create and mark an image as cloud-init compatible in #8807 - Follow steps 4-7 above * Move user data validation warning Co-authored-by: Hussain Khalil <hussain@sanpilot.co> * Update user data validation warning UX copy Co-authored-by: Hussain Khalil <hussain@sanpilot.co> * Refactor user data validation event handler Co-authored-by: Hussain Khalil <hussain@sanpilot.co> * Slighly refactor user data validation Co-authored-by: Hussain Khalil <hussain@sanpilot.co> * Pull in tss-react & related changes from #8821 (#8843) * feat: [M3-6146] - Add User Data to Linode Rebuild flow (#8850) * feat: [M3-6145, M3-6191, M3-6233] - Add User Data to Linode Clone and Backup flow (#8859) * Functional flow * add UserDataAccordion.test.tsx * Fix test * Feedback + styling fixes and unit test updates * Add User Data to Linode Clone flow * Add respective user data warning message. * code cleanup * organize UserDataAccordion componet * Code cleanup * refactor: combine two conditional statemets to single one. * Unit test coverage * code cleanup * refactor: code cleanup --------- Co-authored-by: Dajahi Wiley <dwiley@linode.com> * fix: [M3-6254] - Show warning message for only Linode clone and backups (#8888) * fix: [M3-6254] show warning message for only Linode clone and backups flow * PR -feedback * PR Feedback * PR Feedback * Revert "Revert "Merge branch 'develop' into feature/metadata"" This reverts commit 35daaf1. * feat: [M3-6432] - Add Metadata Feature flag (#8910) ## Description 📝 Feature flag Metadata ## How to test 🧪 Toggle the flag on/off with the dev tools and check that Metadata features display/hide in these flows: Image Create - Capture Image - Upload Image Linode Create via - Rebuild - Distribution - Custom Image - Backups - Clone * address feedback --------- Co-authored-by: Hussain Khalil <hkhalil@akamai.com> Co-authored-by: Hussain Khalil <hussain@sanpilot.co> Co-authored-by: Mariah Jacobs <114685994+mjac0bs@users.noreply.github.com> Co-authored-by: cpathipa <119517080+cpathipa@users.noreply.github.com> Co-authored-by: Dajahi Wiley <dwiley@linode.com> Co-authored-by: hkhalil-akamai <122488130+hkhalil-akamai@users.noreply.github.com> Co-authored-by: Dajahi Wiley <114682940+dwiley-akamai@users.noreply.github.com>
Description 📝
Adds User Data section to the Linode Rebuild flow when an image with
cloud-init
capability is selected.Preview 📷
To-Do
How to test 🧪
{ metadata: { user_data: [encoded string ...] } }
property (ornull
instead of encoded string when the Reuse checkbox is marked)